Skip to content
Snippets Groups Projects
Commit c6eb4387 authored by SAM CARPENTER's avatar SAM CARPENTER
Browse files

file organization documentation

parent 1bc0fea9
No related branches found
No related tags found
No related merge requests found
# IICS Swagger File Public Repository # IICS Swagger File Public Repository
This repository's purpose is to store the various Swagger 2.0 files that CDI uses in its various Business Service connections. More information on this process (in the context of PersonAPI) can be found [In This Document](https://git.doit.wisc.edu/interop/iics/external-iics-docs/-/blob/master/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md). This repository's purpose is to store the various Swagger 2.0 files that CDI uses in its various Business Service connections. More information on this process (in the context of PersonAPI) can be found [In This Document](https://git.doit.wisc.edu/interop/iics/external-iics-docs/-/blob/master/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md).
For more information on how to properly organize your files within this repository, please refer to our [File Organization Guidelines](file-organization-guidelines.md)
file-organization-guidelines-screenshot.png

32.9 KiB

# File Organization Guidelines
The IICS Swagger File Public Repository is a shared environment, and like any shared environment the users should follow organizational schema.
No Swagger files should exist in the root directory, and should be placed into folders within that directory whenever possible. These folders should be organized based on whatever project you are using these swagger files for, or alternatively by the api the files are created to interact with. If your team is planning on using this repository for many projects, they can create a folder for their team and place project folders within that folder. A text-based illustration of what this schema might potentially look like is located below.
![Text-based illustration of the file organization](file-organization-guidelines-screenshot.png)
The Integration Team will provide several swagger files for integrators to use to interact with several common UW-Madison APIs. These will be provided in a yet-to-be determined folder on this repository.
\ No newline at end of file
TODO
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment