feat: complete swagger api documentation with auth examples#324
Open
fahatadam wants to merge 1 commit into
Open
feat: complete swagger api documentation with auth examples#324fahatadam wants to merge 1 commit into
fahatadam wants to merge 1 commit into
Conversation
|
@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! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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. Themain.tsentry file was updated to properly document the custom Stellar Wallet signature challenge-response authentication mechanism.Why it was done
The previously generated
/api/docsendpoint 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
@nestjs/swaggertypescript types.(Note: Please start the backend and verify the
/api/docsendpoint rendering in your local environment.)