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.

Sign up for GitHub

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

Jump to bottom

Implement OpenAPI v3 specification/documentation for the REST API #26

Open
jonathansick opened this issue Apr 26, 2018 · 0 comments
Open

Implement OpenAPI v3 specification/documentation for the REST API #26

jonathansick opened this issue Apr 26, 2018 · 0 comments
Labels
docs Documentation update enhancement
Milestone
api-v2

Comments

@jonathansick
Copy link
Member

I think OpenAPI v3 will be our long-term solution for REST API docs. Lets build the OpenAPI v3 spec (as YAML) and deprecate the current system of docstrings for documenting the endpoints.

See http://idratherbewriting.com/learnapidoc/pubapis_openapi_tutorial_overview.html to get started.
@jonathansick jonathansick added enhancement docs Documentation update labels Apr 26, 2018
@jonathansick jonathansick added this to the api-v2 milestone Apr 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation update enhancement
Projects
None yet
Milestone
api-v2
Development

No branches or pull requests
1 participant
@jonathansick