feat: 3.1.0 roles in security schema for all types #513
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
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.
The OpenAPI 3.1.0 spec, currently in RC2, has formalized that the security schema will allow all security types to specify "roles" using the same syntax as OAuth2 and OIDC scopes: by simply putting strings into what previously was forced to be an empty array. These strings do not need to be enumerated in the security component, as they do with OAuth2 and OIDC.
Conveniently, this is a new feature that can be implemented entirely by deleting code! This PR allows roles to be specified, using the same scopes mechanism already in place.