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 API endpoints #46

Open
prayujt opened this issue Feb 21, 2023 · 0 comments
Open

Add documentation for API endpoints #46

prayujt opened this issue Feb 21, 2023 · 0 comments
Labels
back-end This is a back-end issue

Comments

@prayujt
Copy link
Collaborator

prayujt commented Feb 21, 2023

Problem To Be Solved

There is no documentation for the HTTP endpoints

Motivation

This will make it very difficult for the front-end team to understand what to pass in to each request and what they will receive back, and requires them to look through the back-end code and figure it out themselves.

Proposed Solution

Add a README.md file in the api folder, or some other form of documentation that records each endpoints, the request type, the body and query parameters, and the expected response format in JSON.

@prayujt prayujt added the back-end This is a back-end issue label Feb 21, 2023
@kthchew kthchew mentioned this issue Feb 23, 2023
12 tasks
@kthchew kthchew mentioned this issue Apr 13, 2023
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
back-end This is a back-end issue
Projects
None yet
Development

No branches or pull requests

1 participant