-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
serve swagger [SLT-449] #3359
serve swagger [SLT-449] #3359
Conversation
WalkthroughThe changes introduce a new GET endpoint at Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
packages/rest-api/src/app.ts (1)
59-61
: LGTM! Consider adding cache headers.The implementation is clean and follows Express patterns. However, consider adding cache headers similar to the
/api-docs
endpoint to prevent unnecessary server load.app.get('/swagger.json', (_req, res) => { + res.set('Cache-Control', 'no-store, no-cache, must-revalidate, proxy-revalidate'); + res.set('Pragma', 'no-cache'); + res.set('Expires', '0'); + res.set('Surrogate-Control', 'no-store'); res.json(specs); });
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
packages/rest-api/src/app.ts
(1 hunks)
🔇 Additional comments (1)
packages/rest-api/src/app.ts (1)
59-61
: Consider adding access controls to the Swagger documentation.
The Swagger specifications might contain sensitive API information. Consider implementing authentication/authorization middleware to restrict access to trusted consumers.
Let's verify if there are any existing auth middlewares in use:
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3359 +/- ##
=============================================
Coverage 90.44834% 90.44834%
=============================================
Files 54 54
Lines 1026 1026
Branches 82 82
=============================================
Hits 928 928
Misses 95 95
Partials 3 3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Deploying sanguine-fe with Cloudflare Pages
|
Description
Serve swagger
Summary by CodeRabbit
New Features
/swagger.json
to retrieve API specifications in JSON format.Bug Fixes