Skip to content

feat: Swagger addition/OpenAPI documentation for all endpoints#456

Open
EmmyKay0026 wants to merge 2 commits into
StayLitCodes:mainfrom
EmmyKay0026:feat/add-swagger-openapi-doc
Open

feat: Swagger addition/OpenAPI documentation for all endpoints#456
EmmyKay0026 wants to merge 2 commits into
StayLitCodes:mainfrom
EmmyKay0026:feat/add-swagger-openapi-doc

Conversation

@EmmyKay0026

@EmmyKay0026 EmmyKay0026 commented Jun 29, 2026

Copy link
Copy Markdown

Closes #405


Add Swagger/OpenAPI documentation for backend APIs

This PR adds comprehensive Swagger/OpenAPI documentation for the backend API, including controller tags, operation summaries, request/response metadata, DTO property descriptions, and JWT bearer auth support in the generated docs.

What changed

  • Configured Swagger UI and OpenAPI generation at /api/docs
  • Added bearer auth support for protected endpoints
  • Documented core and secondary backend controllers, including auth, escrow, admin, notifications, webhook, app version,
  • API key, IPFS, and Stellar endpoints
  • Added DTO-level property metadata for request payloads
  • Added a regression test to ensure Swagger decorators remain covered
  • Added CI enforcement for Swagger documentation coverage

Verification

  • Ran the Swagger regression test: passed
  • Ran the backend build: succeeded
image

@drips-wave

drips-wave Bot commented Jun 29, 2026

Copy link
Copy Markdown

@EmmyKay0026 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.

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

1 participant