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

Add API Endpoint Documentation #23

Open
terrameijar opened this issue Jan 25, 2024 · 1 comment
Open

Add API Endpoint Documentation #23

terrameijar opened this issue Jan 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@terrameijar
Copy link
Collaborator

The API is currently undocumented. Add documentation to make it easy to build against the API.
We should consider using a tool like Swagger to document our endpoints.
@terrameijar terrameijar added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 25, 2024
@maunga-et
Copy link
Collaborator

I added swagger and redoc specs here. I created a pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@terrameijar @maunga-et