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 documentation #69

Open
shubhbapna opened this issue Oct 9, 2022 · 3 comments
Open

Add API documentation #69

shubhbapna opened this issue Oct 9, 2022 · 3 comments
Assignees
@ggggg
Labels
backend This is related to the server documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@shubhbapna
Copy link
Collaborator

Describe the solution you'd like
Document each API (method, path, any path params, any queries, any request body, responses etc)
@shubhbapna shubhbapna added documentation Improvements or additions to documentation good first issue Good for newcomers backend This is related to the server labels Oct 9, 2022
@ggggg
Copy link
Collaborator

ggggg commented Nov 16, 2022

In README or in code comments?

@huonggiangbui
Copy link
Member

I think we might want another doc (another .md)!

@ggggg
Copy link
Collaborator

ggggg commented Nov 16, 2022

Alrighty, can you please assign me to this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ggggg ggggg

Labels
backend This is related to the server documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ggggg @shubhbapna @huonggiangbui