Use SecurityDefinitions type for _componentsSecuritySchemes
#32
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
Problem: there is `SecurityDefinitions` newtype which is unused. Long ago it was used to store security schemas, but then in 821654c the corresponding field changed to `Definitions SecurityScheme`. There is one essential difference caused by this change: now if we mappend two `Components` (or other types that hold `Components` inside) and both sides have `SecuritySchemeOAuth2`, they won't be merged. Solution: change `_componentsSecuritySchemes` to `SecurityDefinitions`.
When we concatenate OpenApi objects, we want security schemes to be merged deeply, so that if there are 2 `OAuth2Flows` in `SecuritySchemeOAuth2`, they are concatenated. Previously it wasn't tested and was failing without the previous fix. The new test concatenates two `OpenApi` objects with `SecuritySchemeOAuth2`.
|
@maksbotan I think it's ready for review. I've added a test that fails without my change and doesn't fail with my change. Please note that it's a breaking change. |
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.
Problem: there is
SecurityDefinitionsnewtype which is unused.Long ago it was used to store security schemas, but then in 821654c
the corresponding field changed to
Definitions SecurityScheme.There is one essential difference caused by this change: now if we
mappend two
Components(or other types that holdComponentsinside) and both sides have
SecuritySchemeOAuth2, they won't bemerged.
Solution: change
_componentsSecuritySchemestoSecurityDefinitions.Resolves #30