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

Decide on API Documentation #13

Open

1 task

Jose-S opened this issue Oct 16, 2020 · 0 comments

Assignees

Labels

documentation good first issue

Member

Jose-S commented Oct 16, 2020 •

edited by ChiliPaneer

Loading

Problem:
We want to have consistent documentation that we can refer back to for our API.

Specs:

Identify a solution for documenting our API and document it there

Notes
https://swagger.io/
https://stackoverflow.com/questions/36634281/list-of-swagger-ui-alternatives
We updated the documentation here but it might be nice to have something like swagger?

If blocked, contact @emaela or @Jose-S

Jose-S added the documentation label

emaela assigned emaela and unassigned emaela

sophiacrennan added the good first issue label

ChiliPaneer self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment