Generate Valid OpenAPI When JWTSecurity is Used #1758
Merged
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.
Adding the "In" and "Name" field to the JWTSecurity scheme expression so it generates a valid OpenAPI securityDefinitions section.
Before this change, a design with the following security scheme would generate an invalid OpenAPI securityDefinitions section.
Design:
Output OpenAPI without these changes:
When copy pasted to https://editor.swagger.io/, the OpenAPI causes:
This change populates the required
in
andname
fields when specifying an apiKey securityDefinitions and gets rid of the https://editor.swagger.io/ errors.Output OpenAPI with these changes:
For more information please see: