chore(rest-api): rename swagger.json to openapi.json [SLT-449] #3362
Conversation
|
Warning Rate limit exceeded@trajan0x has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 28 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe pull request updates the REST API documentation to include a note about the OpenAPI 3.0 specification and clarifies the deprecation of a previous API URL. Additionally, it modifies the Changes
Possibly related PRs
Suggested reviewers
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
|
Deploying sanguine-fe with
|
| Latest commit: |
f3fdaae
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://1cccbd3d.sanguine-fe.pages.dev |
| Branch Preview URL: | https://fix-swagger-rename.sanguine-fe.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3362 +/- ##
=============================================
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. |
Bundle ReportChanges will decrease total bundle size by 3.44MB (-9.64%) ⬇️. This is within the configured threshold ✅ Detailed changes
ℹ️ *Bundle size includes cached data from a previous commit |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
packages/rest-api/src/app.ts (1)
59-61: Consider adding backward compatibility measures.While renaming from
/swagger.jsonto/openapi.jsonaligns with modern practices, this is a breaking change that could affect existing API consumers. Consider adding a temporary redirect from the old endpoint.Add this before the new endpoint:
+app.get('/swagger.json', (_req, res) => { + res.redirect(301, '/openapi.json'); +}); app.get('/openapi.json', (_req, res) => { res.json(specs) })
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
docs/bridge/docs/02-Bridge/02-REST-API.md(1 hunks)packages/rest-api/src/app.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/bridge/docs/02-Bridge/02-REST-API.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
see #3361
Description
3960938: docs preview link
Summary by CodeRabbit
Documentation
New Features
/swagger.jsonto/openapi.jsonfor serving OpenAPI specifications.Bug Fixes
245dfc0: docs preview link
8a431b3: docs preview link