diff --git a/README.md b/README.md index 80e5505eeb3b8f9ce1eccb7f27b10e7f08be83dd..77e115c443f2a7c869aaa74178c375e858c194c3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ # 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). + +For more information on how to properly organize your files within this repository, please refer to our [File Organization Guidelines](file-organization-guidelines.md) diff --git a/file-organization-guidelines-screenshot.png b/file-organization-guidelines-screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..c9355b8da145771a30aa833ad8415ecd7c5f8ed6 Binary files /dev/null and b/file-organization-guidelines-screenshot.png differ diff --git a/file-organization-guidelines.md b/file-organization-guidelines.md new file mode 100644 index 0000000000000000000000000000000000000000..c1c7f6a36ff510c198c0bb912fde28029f7dedb0 --- /dev/null +++ b/file-organization-guidelines.md @@ -0,0 +1,9 @@ +# 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. + + + +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 diff --git a/personapispeciics/README.md b/personapispeciics/README.md deleted file mode 100644 index 30404ce4c54634bf430d2d154c10c45b8b1eebc1..0000000000000000000000000000000000000000 --- a/personapispeciics/README.md +++ /dev/null @@ -1 +0,0 @@ -TODO \ No newline at end of file