ni / systemlink-OpenAPI-documents

MIT License
16 stars 22 forks source link

Initial commit of the File Swagger API #7

Closed BKnight760 closed 6 years ago

BKnight760 commented 6 years ago

This is the existing YML that has already been reviewed and is in use by the File service.

[x] This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

This pull request adds a Swagger document for the File service. This will be the master copy of the File service's Swagger document, for use in SystemLink Server. This document is used as the source for the webservice interface which is implemented by the File service.

Why should this Pull Request be merged?

This pull request gives higher visibility to the File HTTP API, and ensures that the implentation matches the fully documented options for the webservice.

What testing has been done?

New automated python tests were added when the File service was switched to using the Swagger code-generation for the webservice interface. Existing automated tests have been run against the swagger interface, and all tests pass.