The API documentation should show real examples of requests and responses to help developers understand how to use it.
What to do:
Add example data to the Swagger/OpenAPI documentation for all endpoints.
Why this matters:
- Developers can copy-paste working examples
- Reduces time to integrate with API
- Shows the full power of the system
- Standard practice for APIs
Acceptance criteria:
- All endpoints have request examples
- All endpoints have response examples
- Examples show realistic scenarios
- Examples use consistent test data
https://stackoverflow.com/questions/70331521/swagger-openapi-model-example-value
The API documentation should show real examples of requests and responses to help developers understand how to use it.
What to do:
Add example data to the Swagger/OpenAPI documentation for all endpoints.
Why this matters:
Acceptance criteria:
https://stackoverflow.com/questions/70331521/swagger-openapi-model-example-value