Handle Swagger slash basepath within Swagger UI Middleware #1835
Conversation
This file contains 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
There was a problem hiding this comment.
Thanks @nielsbox! The fix looks good, but some comments on the tests.
Ruwann
reviewed
Feb 14, 2024
| @@ -269,7 +269,7 @@ def base_path(self): | |||
|
|
|||
| @base_path.setter | |||
| def base_path(self, base_path): | |||
| base_path = canonical_base_path(base_path) | |||
There was a problem hiding this comment.
This function seems to be fairly specific for this usecase, can we adjust it instead or create a different util function that adjust the behaviour of canonical_base_path in this way?
Then it's also easier to test because we can just write a unit test for that util function
| @@ -269,7 +269,7 @@ def base_path(self): | |||
|
|
|||
| @base_path.setter | |||
| def base_path(self, base_path): | |||
| base_path = canonical_base_path(base_path) | |||
There was a problem hiding this comment.
A bit wider comment: the property itself still uses the canonical_base_path function, so the "getter" returns a different value, there's also the added complexity that the base path is used as Flask blueprint name, which has its own rules
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.
Fixes #1834 .
Changes proposed in this pull request: