-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Description
The project has 18 API modules but no standalone API documentation. Adding a docs/api.md with endpoint descriptions and example requests would help both contributors and users.
What to do
- Create
docs/api.md - Document key API groups with endpoints, methods, and example curl commands:
- Auth (
/api/auth/) - Agents (
/api/agents/) - Tasks (
/api/tasks/) - Files (
/api/files/)
- Auth (
- FastAPI auto-generates docs at
/docs— use that as reference
Resources
- API routes:
backend/app/api/(18 router files) - FastAPI Swagger UI:
http://localhost:8008/docs(when running)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers