feat(openapi): use root_path for default server URL#4625
Open
ndpvt-web wants to merge 1 commit intolitestar-org:mainfrom
Open
feat(openapi): use root_path for default server URL#4625ndpvt-web wants to merge 1 commit intolitestar-org:mainfrom
ndpvt-web wants to merge 1 commit intolitestar-org:mainfrom
Conversation
When no servers are explicitly configured in OpenAPIConfig, use the ASGI root_path from the request scope as the default server URL. This makes the OpenAPI schema work correctly when the app is deployed behind a reverse proxy with a path prefix. Closes litestar-org#2077 Co-Authored-By: AI Assistant (Claude) <ai-assistant@contributor-bot.dev> Signed-off-by: ndpvt-web <ndpvt-web@users.noreply.github.com>
github-actions
bot
added
area/openapi
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
When no servers are explicitly configured in
OpenAPIConfig, this change uses the ASGIroot_pathfrom the request scope as the default server URL. This makes the OpenAPI schema work correctly when the app is deployed behind a reverse proxy with a path prefix.Previously, the default server URL was always
"/"regardless of theroot_pathsetting. Now, ifroot_pathis present in the scope and no custom servers are configured, the schema endpoint dynamically sets the server URL to theroot_pathvalue.This follows the approach suggested by @peterschutt in the issue discussion.
Closes #2077
Changes
litestar/_openapi/plugin.pyto check forroot_pathin the request scope when serving the OpenAPI schemaroot_pathis present, uses it as the default server URLAI Disclosure
This PR was created with AI assistance (Claude by Anthropic). The implementation follows the approach outlined by maintainers in the issue discussion.
Co-Authored-By: AI Assistant (Claude) ai-assistant@contributor-bot.dev