Skip to content

API Docs: Add OpenAPI/Swagger documentation #5

Description

@OneByJorah

API Documentation Gap

Current State: No API documentation exists. The backend has many REST endpoints but no auto-generated docs.

Required:

  1. Add OpenAPI/Swagger spec generation:

    • Backend: Use flasgger or apispec with Flask
    • Generate OpenAPI 3.0 spec
    • Serve Swagger UI at
    • Serve ReDoc at
  2. 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
  3. Add request/response schemas with examples

  4. Add authentication documentation (Bearer token)

  5. Add to CI to validate spec

Priority: MEDIUM

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions