Repository navigation
fix(backend): add OpenAPI 3.0 annotations for authentication routes - #1374
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
🚀 Impressive! A new contribution to CropChain! Thank you for your Pull Request. To help us merge this smoothly, please ensure:
We will review your code soon. Happy building! 🌾✨ |
This branch had an error being deployed
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
2 participants
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.
📌 Overview
This PR adds missing OpenAPI / Swagger 3.0 JSDoc annotations to
backend/routes/authRoutes.js.Previously,
tests/swaggerDoc.test.jsfailed because/api/auth/registerand/api/auth/loginwere not indexed inswaggerSpec.paths. Adding these annotations documents registration, login, token refresh, and logout in the interactive documentation at/api/docsand fixes the test suite.🔗 Related Issue
Closes #1369
🧪 Testing & Verification
node -c backend/routes/authRoutes.js(passed)npx jest tests/swaggerDoc.test.js(4/4 tests passed)