OpenAPI docs for scopes defined on a single route #1592
Closed
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.
Scopes that are defined on an individual route as part of a
Security
Dependency were not being returned on the OpenAPI JSON that is generated.This seems to be because when the dependencies are flattened the
security_scopes
are not being flattened (unlikesecurity_requirements
and others which are). This sets the default scopes to an empty list and flattens the scopes of sub dependencies. I've added a test which confirms this in the OAuth2 test.I'm brand new to the FastAPI code base so I am unsure if there are any unintended consequences with this approach - but all the tests seem to pass and the new behaviour makes sense in my understanding of what the code should do.