Description
The CAIMS API needs proper documentation. Adding Swagger/OpenAPI docs would help developers understand and use the API.
What to do
- Install
next-swagger-doc or swagger-jsdoc
-
- Add OpenAPI annotations to all API routes (
/api/chat, /api/debate, /api/sessions, /api/scores)
-
- Create a
/api/docs page with Swagger UI
-
- Document request/response schemas using existing Zod schemas
-
- Add example requests and responses
Skills needed
References
- API routes:
apps/web/app/api/
-
- Zod schemas in each route file
Description
The CAIMS API needs proper documentation. Adding Swagger/OpenAPI docs would help developers understand and use the API.
What to do
next-swagger-docorswagger-jsdoc/api/chat,/api/debate,/api/sessions,/api/scores)/api/docspage with Swagger UISkills needed
References
apps/web/app/api/