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

Add documentation for all the API endpoints #8

Open
krashish8 opened this issue Nov 5, 2021 · 2 comments
Open

Add documentation for all the API endpoints #8

krashish8 opened this issue Nov 5, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@krashish8
Copy link
Member

The documentation is already added, but it might not be correct and complete (because the main focus was on development).

Using swag for generating API documentation using annotaions.

@krashish8 krashish8 added the documentation Improvements or additions to documentation label Nov 5, 2021
@dkastl
Copy link
Member

dkastl commented Nov 5, 2021

Adding example could be also helpful: https://swagger.io/docs/specification/adding-examples/

@krashish8
Copy link
Member Author

The documentation of all the API endpoints is almost done. Maybe we can add some detailed description about this application in the documentation, if that is possible in swagger.

Also added a sample (random) example for each endpoint, i.e. a prefilled value for each key-value pair, through which one can understand the type and format of the value required, or maybe directly make the request with the prefilled data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants