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 Response Documentation #24

Open
GautamAnjali569 opened this issue Feb 1, 2025 · 2 comments
Open

Add API Response Documentation #24

GautamAnjali569 opened this issue Feb 1, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request Medium

Comments

@GautamAnjali569
Copy link
Member

Description

The API responses are not well-documented, making it hard for developers to understand the expected output.

Steps to Implement

  1. Create an API_DOCS.md file.
  2. Document available endpoints, request parameters, and sample responses.
  3. Format the documentation for easy readability.

Expected Outcome

Developers can easily understand the API structure and expected responses.
@Durgesh4993 Durgesh4993 added documentation Improvements or additions to documentation enhancement New feature or request Medium labels Feb 1, 2025
@Shiv10122003
Copy link

please assign me this issue under iwoc

@GautamAnjali569
Copy link
Member Author

@Durgesh4993

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 enhancement New feature or request Medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Durgesh4993 @Shiv10122003 @GautamAnjali569