API Documentation Gap
Current State: No API documentation exists. The backend has many REST endpoints but no auto-generated docs.
Required:
-
Add OpenAPI/Swagger spec generation:
- Backend: Use flasgger or apispec with Flask
- Generate OpenAPI 3.0 spec
- Serve Swagger UI at
- Serve ReDoc at
-
Document all endpoints:
- Auth: POST /api/auth/login, POST /api/auth/register, GET /api/auth/me, PUT /api/auth/password, POST /api/auth/logout
- Streams: GET/POST /api/streams, PUT/DELETE /api/streams/
- Recordings: GET/POST /api/recordings, DELETE /api/recordings/
- Events: GET/POST /api/events
- Schedules: GET/POST /api/schedules, PUT/DELETE /api/schedules/
- Analytics: GET /api/analytics/overview
- Backup: GET/POST /api/backup
- Health: GET /health
-
Add request/response schemas with examples
-
Add authentication documentation (Bearer token)
-
Add to CI to validate spec
Priority: MEDIUM
API Documentation Gap
Current State: No API documentation exists. The backend has many REST endpoints but no auto-generated docs.
Required:
Add OpenAPI/Swagger spec generation:
Document all endpoints:
Add request/response schemas with examples
Add authentication documentation (Bearer token)
Add to CI to validate spec
Priority: MEDIUM