[API-QA] Add missing Swagger documentation for Auth endpoints

[kingksjo]

Domain: Documentation

---

Issue [API-QA] Add missing Swagger documentation for Auth endpoints

Tier: 🟢 Easy

Description:

• Problem: docs/swagger.yaml currently documents only POST /api/auth/signup, POST /api/auth/login, and POST /api/auth/api-keys. Missing routes include any refresh-token, logout, or password-reset flows that may exist in src/modules/auth/auth.routes.ts.
• Implementation: Audit src/modules/auth/auth.routes.ts, identify all registered paths, and add their OpenAPI definitions to docs/swagger.yaml.

Dependencies:

• Depends on None

Acceptance Criteria:

• Every route in auth.routes.ts has a corresponding Swagger path entry.
• Auth endpoints that are public (no bearerAuth) explicitly omit the security block.
• Response schemas reflect the actual controller return shapes.
• Refresh/logout endpoints document cookie or header requirements if applicable.

Testing Requirements:

• Swagger UI renders updated auth paths without YAML syntax errors.
• npm run build passes with zero warnings.
• Route audit list attached to PR.

PR Checklist:

• Branch is named conventionally (e.g., docs/issue-58-auth-swagger).
• npm run lint and npm run build pass with zero warnings.

[Itodo-S]

@Itodo-S has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

Please let me work on this issue; I can handle it.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Itodo-S to this issue.

[Mehcee]

@Mehcee has applied to work on this issue as part of the Stellar Wave Program's 5th wave.

I would like to work on this issue

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Mehcee to this issue.

[drips-wave]

Congratulations, @Mehcee! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on June 2, 2026.

🧑‍💻 @Mehcee: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

Warning

When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

🌊 Happy Wave 🌊