search

ni / systemlink-OpenAPI-documents

MIT License
16 stars 22 forks source link

Initial commit of the TDM Reader swagger API #8

Closed BKnight760 closed 6 years ago

BKnight760 commented 6 years ago

Initial commit of the nitdmreader.yml swagger doc. This is used by the TDM Reader service, but is not code-generated into a a webservice interface yet.

[x] This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

This pull request adds a Swagger document for the TDM Reader service. This will be the master copy of the TDM Reader service's Swagger document, for use in SystemLink Server.

Why should this Pull Request be merged?

This pull request gives higher visibility to the TDM Reader HTTP API.

What testing has been done?

Existing automated tests have been run against webservice, and all tests pass.

adelcast commented 6 years ago

Should we change the section name for Properties to something more meaningful like Metadata? The problem is that Properties already have a meaning (Channels, Files and Groups have properties). The query-files endpoint returns metadata as well as properties (maybe the endpoint name should change too?)