fix: duplication in request URL path when configuring OpenAPI #3306 #4072
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
github-actions
bot
added
area/openapi
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4072 +/- ##
==========================================
- Coverage 98.34% 98.30% -0.04%
==========================================
Files 348 348
Lines 15829 15841 +12
Branches 1749 1753 +4
==========================================
+ Hits 15567 15573 +6
- Misses 125 129 +4
- Partials 137 139 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
litestar/_openapi/plugin.py
Outdated
| """ | ||
| path = route.path_format or "/" | ||
| if self.app.path != "/": | ||
| return path.replace(self.app.path, "") or "/" |
There was a problem hiding this comment.
This can easily lead to bugs, if self.app.path is contained somewhere within path. If we are to do this, it should use .removeprefix.
There was a problem hiding this comment.
@provinzkraut Maybe use return path[len(self.app.path):] or "/" to support Python 3.8. ?
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4072 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
I would like to propose a solution for issue #3306. I have created two methods in
OpenAPIPlugin:_normalize_route_pathis designed to remove redundant parts from the URL. Here, I assume that the URLs specified in servers have higher priority when building the Open API schema._normalize_default_serveris needed in cases where the user setsapp.pathbut does not defineserversinOpenApiConfig