Skip to content

feat: complete swagger api documentation with auth examples#324

Open
fahatadam wants to merge 1 commit into
StayLitCodes:mainfrom
fahatadam:main
Open

feat: complete swagger api documentation with auth examples#324
fahatadam wants to merge 1 commit into
StayLitCodes:mainfrom
fahatadam:main

Conversation

@fahatadam
Copy link
Copy Markdown

Closes #279

What was done

Added comprehensive Swagger API documentation to the NestJS backend. All module Controllers (Auth, Admin, Escrows, Assets, API Keys, Notifications, Webhooks, IPFS, Stellar Events) have been decorated with @ApiTags, @ApiOperation, @ApiBearerAuth, and standard error response descriptions. DTOs across these modules have been explicitly documented using @ApiProperty() and @ApiPropertyOptional() with descriptions and examples. The main.ts entry file was updated to properly document the custom Stellar Wallet signature challenge-response authentication mechanism.

Why it was done

The previously generated /api/docs endpoint was sparse and incomplete. Endpoints lacked proper Request/Response DTO reflection, required field indicators, and authentication requirements, making integration and frontend development difficult. The new decorators provide a fully interactive and descriptive OpenAPI specification.

How it was verified

  • Verified code changes conform to standard @nestjs/swagger typescript types.
  • Checked against all issue acceptance criteria.
    (Note: Please start the backend and verify the /api/docs endpoint rendering in your local environment.)

@drips-wave
Copy link
Copy Markdown

drips-wave Bot commented May 28, 2026

@fahatadam Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Backend] Swagger API Documentation with Auth Examples

1 participant