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

Improve api documentation #87

Open
galbwe opened this issue Aug 11, 2021 · 0 comments
Open

Improve api documentation #87

galbwe opened this issue Aug 11, 2021 · 0 comments
Labels
backend good first issue Good for newcomers

Comments

@galbwe
Copy link
Collaborator

galbwe commented Aug 11, 2021

Run the swagger docs locally by starting the api with docker compose

docker compose up --build

Follow the instructions in the README to access the docs

Some of the endpoints only have response schemas for the 200 responses. One direction is to add response schemas for error responses. Check the blueprints directory in the backend for the definitions of the endpoints and their responses.

Refer to the swagger 2 docs for additional swagger features to add. Pretty much any improvement on the existing docs is welcome!

@galbwe galbwe added good first issue Good for newcomers backend labels Aug 11, 2021
@galbwe galbwe added the Hacktoberfest Hacktoberfest 2021 label Oct 1, 2021
@yimjay yimjay assigned yimjay and unassigned yimjay Oct 7, 2021
@galbwe galbwe self-assigned this Oct 26, 2021
@galbwe galbwe removed the Hacktoberfest Hacktoberfest 2021 label Nov 2, 2021
@galbwe galbwe removed their assignment Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants