-
Notifications
You must be signed in to change notification settings - Fork 417
Update openapi.md scalar documentation #651
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: main
Are you sure you want to change the base?
Conversation
`cdn` is not part of the official Scalar configuration, but it is part of the Scalar plugin and provides a means of overriding the scalar URI to the scalar bundle.
WalkthroughAdds a "Self-hosted Scalar bundle" subsection to the OpenAPI plugin docs showing Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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)
docs/plugins/openapi.md (1)
169-180
: Clarify plugin-specific override forcdn
Add a note that
cdn
is an Elysia OpenAPI plugin option (not part of Scalar’s native config) and update inline comments for clarity.Apply this diff:
### Self-hosted Scalar bundle -Self-host the Scalar bundle and disable CDN Fonts. +Self-host the Scalar bundle and disable CDN Fonts. + +Note: `cdn` is an Elysia OpenAPI plugin option (not part of Scalar’s own config); it overrides the URI to the Scalar bundle. ```typescript - openapi({ + openapi({ scalar: { - cdn: "/public/scalar-standalone.min.js", //Self-hosted - withDefaultFonts: false, //Disable CDN Fonts + cdn: "/public/scalar-standalone.min.js", // plugin override for Scalar bundle URI (self-hosted) + withDefaultFonts: false, // disable Scalar’s default font CDN }, })</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between b6a67d1e78e78d17e1a1d8194b0e7b72d90c4d84 and af8c3d7caaea8db34606915f609358fb1f7a3446. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/plugins/openapi.md` (1 hunks) </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Incorporated @coderabbitai's nitpick comments.
cdn
is not part of the official Scalar configuration, but it is part of the Scalar plugin and provides a means of overriding the scalar URI to the scalar bundle.Summary by CodeRabbit