Skip to content

Expand Payment Module Swagger Documentation #26

@fati-Onchain

Description

@fati-Onchain

Description: The payments controller has minimal Swagger documentation compared to the auth and users modules. Add full OpenAPI annotations for all payment endpoints.

Tasks:

  • Add @ApiTags, @ApiOperation, and @ApiResponse decorators to all payment endpoints
  • Document request body DTOs with @ApiProperty descriptions and examples
  • Document all possible response codes (200, 400, 401, 404, 422, 500)
  • Add authentication requirements (@ApiBearerAuth) to protected routes
  • Verify the Swagger UI renders all payment endpoints correctly

Acceptance Criteria:

  • All payment endpoints are fully documented in Swagger UI
  • Example request/response bodies are shown
  • Auth requirements are indicated on protected endpoints

ETA: 1 day


Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave program

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions