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

Improve API doc #100

Open
KaloyanTanev opened this issue Nov 9, 2021 · 0 comments
Open

Improve API doc #100

KaloyanTanev opened this issue Nov 9, 2021 · 0 comments
Labels
good first issue Good for newcomers

Comments

@KaloyanTanev
Copy link
Contributor

Currently the API doc does the job, but it could be greatly improved:

  • detailed fields for the POST requests and not just json/body as a parameter
  • example values for requests - both GET and POST
  • example values for responses - both GET and POST
  • expected error messages for responses
@KaloyanTanev KaloyanTanev added the good first issue Good for newcomers label Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@KaloyanTanev