Skip to content

Implement automated API documentation generation from OpenAPI specs #404

@Smartdevs17

Description

@Smartdevs17

Description

API documentation is maintained separately and often out of date. Implement OpenAPI/Swagger spec generation from TypeScript types with automated docs deployment.

Acceptance Criteria

  • OpenAPI spec generation from Zod schemas and Express routes
  • API docs hosted via Swagger UI
  • Automated spec update on each deployment
  • Request/response example generation
  • Authentication flow documentation
  • SDK code generation from OpenAPI spec

Technical Scope

  • backend/scripts/generate-openapi.ts
  • backend/src/lib/openapi-decorators.ts
  • .github/workflows/generate-docs.yml
  • Edge: circular reference handling, large spec performance, versioned docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    200-points200 point issuedrips-waveIssues in the Drips Wave programhighHigh complexity issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions