Skip to content

feat(backend): Add Swagger/OpenAPI documentation for all endpoints #405

Description

@KuchiMercy

Description

@nestjs/swagger and swagger-ui-express installed but API docs incomplete. Add comprehensive auto-generated docs.

Acceptance Criteria

  • @apitags() on all controllers (Escrow, Auth, Admin, Assets, Health, Webhooks, Notifications)
  • @apioperation() with summary on every handler
  • @apiresponse() for all response codes (200, 201, 400, 401, 403, 404, 409, 429, 500)
  • @ApiBearerAuth() on authenticated endpoints
  • @ApiBody() with examples for POST/PATCH/PUT
  • @apiquery() for query parameters
  • @ApiParam() for path parameters
  • @ApiProperty() on all DTOs with descriptions
  • Configure Swagger UI at /api/docs with JWT bearer input
  • Example request/response for core escrow CRUD
  • WebSocket events documentation
  • CI check for missing Swagger decorators

Points: 150

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbackenddocumentationImprovements or additions to documentationenhancementNew feature or requestphase-1Sprint 1-2: Foundation & Stability

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions