-
Notifications
You must be signed in to change notification settings - Fork 44
[CS-688] fix: update ReDoc CDN URL #4861
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
base: dev
Are you sure you want to change the base?
Conversation
Signed-off-by: lewisojile <[email protected]>
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughUpdated the Redoc CDN script source in two documentation generation files, replacing jsdelivr URLs with the official redoc.ly CDN. No functional logic or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Potential review focus:
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (1)
Comment |
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
🧹 Nitpick comments (1)
cla-backend-go/docs/doc.go (1)
45-45: Good fix for the blank screen issue, but consider pinning to a specific version for stability.The switch to the official Redoc CDN is working correctly (HTTP 200 verified). However, using
/latest/means the application will automatically fetch the newest version without control, which could introduce breaking changes or unexpected behavior.Consider pinning to a specific version. The current latest stable version is v2.5.1 (released September 26, 2025):
- <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script> + <script src="https://cdn.redoc.ly/redoc/v2.5.1/bundles/redoc.standalone.js"> </script>Other stable versions available: v2.5.0, v2.4.0, v2.3.0, v2.2.0.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
cla-backend-go/docs/doc.go(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: CodeQL analysis (go)
- GitHub Check: build-test-lint
- GitHub Check: cypress-functional
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.
Pull Request Overview
This pull request updates the Redoc JavaScript bundle CDN source in the API documentation rendering template from jsdelivr to the official Redoc CDN (cdn.redoc.ly). The change also switches from the @next version tag to latest.
- Updated the Redoc CDN URL to use the official
cdn.redoc.lydomain - Changed version specifier from
@nexttolatestin the new CDN format
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <body> | ||
| <redoc spec-url='/v3/swagger.json'></redoc> | ||
| <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script> | ||
| <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script> |
Copilot
AI
Nov 13, 2025
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.
Using latest as the version tag can lead to unexpected breaking changes when Redoc releases new versions. Consider pinning to a specific version (e.g., https://cdn.redoc.ly/redoc/v2.1.3/bundles/redoc.standalone.js) to ensure consistent rendering and avoid potential breaking changes in production.
| <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script> | |
| <script src="https://cdn.redoc.ly/redoc/v2.1.3/bundles/redoc.standalone.js"> </script> |
Signed-off-by: lewisojile <[email protected]>
This pull request updates the source of the Redoc JavaScript bundle used to render API documentation. The change switches the CDN from
jsdelivrtoredoc.ly, which is the official CDN for Redoc.Documentation rendering update:
cla-backend-go/docs/doc.goto use the official Redoc CDN (cdn.redoc.ly) instead ofjsdelivr.