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 Redoc for API documentation #7

Open
SVijayB opened this issue Dec 9, 2021 · 0 comments
Open

Implement Redoc for API documentation #7

SVijayB opened this issue Dec 9, 2021 · 0 comments
Assignees
@SVijayB
Labels
documentation Improvements or additions to documentation

Comments

@SVijayB
Copy link
Member

SVijayB commented Dec 9, 2021

The current API documentation is present in the README.md file. While it's rather straightforward, it could get a little messy when more endpoints are created.

Switching over to Redoc would solve that and also define documentation that follows OpenAPI definitions.
@SVijayB SVijayB added the documentation Improvements or additions to documentation label Dec 9, 2021
@SVijayB SVijayB self-assigned this Dec 9, 2021
@SVijayB SVijayB mentioned this issue Dec 12, 2021
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@SVijayB SVijayB

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@SVijayB