-
Notifications
You must be signed in to change notification settings - Fork 9
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Description:
The API documentation needs more comprehensive examples showing request/response formats for all endpoints.
What needs to be done:
- Add curl examples for each API endpoint in
API_DOCUMENTATION.md - Include sample request bodies and expected responses
- Add error response examples with different status codes
Files to modify:
API_DOCUMENTATION.md
Acceptance Criteria:
- All endpoints have curl examples
- Request/response examples are properly formatted
- Error scenarios are documented with examples
- Examples use realistic sample data
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers