search

NCEAS / metadig-webapp

Web service for interacting with the MDQ Engine API
1 stars 2 forks source link

create swagger docs for the API #4

Open mbjones opened 6 years ago

mbjones commented 6 years ago

Create Swagger API documentation for the API. Use design info from #3.

mbjones commented 6 years ago

See evolving API as we edit it on Swagger here: https://app.swaggerhub.com/apis/mbjones/metadig

gothub commented 6 years ago

Note that there are now 2 versions of the API doc, with the new version using the updated OpenAPI 3.0 version (old was 'Swagger 2.0'). The new doc is

https://app.swaggerhub.com/apis/mbjones/metadig/2.0.0-a1-oas3

This newer version is required to describe http multipart request body sections for PUT and POST requests.

Note that the new editor version is in beta