Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create swagger docs for the API #4

Open
mbjones opened this issue Jan 17, 2018 · 2 comments
Open

create swagger docs for the API #4

mbjones opened this issue Jan 17, 2018 · 2 comments
Assignees
Labels
metadig All issues related to metadig metadig-api
Milestone

Comments

@mbjones
Copy link
Member

mbjones commented Jan 17, 2018

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

@mbjones
Copy link
Member Author

mbjones commented Jan 18, 2018

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

@mbjones mbjones added in progress and removed next labels Jan 18, 2018
@gothub
Copy link
Contributor

gothub commented Jan 20, 2018

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

@mbjones mbjones added the metadig All issues related to metadig label Jun 13, 2018
@gothub gothub modified the milestones: 2.0.0, 2.1.0 Oct 31, 2019
@gothub gothub modified the milestones: 2.1.0, 2.3.0 Apr 27, 2020
@gothub gothub modified the milestones: 2.3.0, 2.4.0 Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
metadig All issues related to metadig metadig-api
Projects
None yet
Development

No branches or pull requests

2 participants