feat(openapi): add custom Scalar render options example #4416
Conversation
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
- Refactor `docs/usage/openapi/ui_plugins.rst` to merge and clarify configuration and customization, avoiding duplication.
github-actions
bot
added
area/docs
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4416 |
JacobCoffee
approved these changes
Oct 10, 2025
| .. literalinclude:: /examples/openapi/plugins/swagger_ui_oauth.py | ||
| :language: python | ||
|
|
||
| Customizing the OpenAPI UI |
There was a problem hiding this comment.
should we have removed this section? it needs to be updated to not be so specific to scalar but i think OpenAPI UI can be customized by overriding the default ``css_url`` and ``js_url`` attributes is generic across all our renderers? can probably leave it alone and have another pr to update
There was a problem hiding this comment.
There was a problem hiding this comment.
should we have removed this section?
- I prefer to remove this section because i found that we already explained
css_urlandjs_urlin https://docs.litestar.dev/main/usage/openapi/ui_plugins.html#configuring-openapi-ui-plugins.
it needs to be updated to not be so specific to scalar
- I agree with you. As far as at the https://docs.litestar.dev/main/usage/openapi/ui_plugins.html#customizing-the-openapi-ui part , it would be better to provide different showcases.
css_urlandjs_urlattributes is generic across all our renderers?
- Negative. RapidDoc and Redoc don't supprt
css_urlbase on API Reference so far. But maybe it's time to leave some #TODO in code to make it generic.
#cdn-and-offline-file-support part is duplicate.
- Maybe we can combine it into #configuring-openapi-ui-plugins part?
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.
Description
This PR added a example that demonstrates how to customize Scalar render options using the
optionsparameter inScalarRenderPlugin.Besides, here is an alternative provided by copilot. I found that there is enhancement after reviewing this PR and then came up with another solution.
Closes #4381 , thanks to @JacobCoffee BTW.