fix(module): filter header params that duplicate security schemes#3785
Open
maruthang wants to merge 1 commit intonestjs:masterfrom
Open
fix(module): filter header params that duplicate security schemes#3785maruthang wants to merge 1 commit intonestjs:masterfrom
maruthang wants to merge 1 commit intonestjs:masterfrom
Conversation
When @headers("Authorization") is used alongside bearer auth, Swagger generated both a security requirement and a redundant header parameter. Now filters out header parameters whose names match security scheme headers (Authorization for http schemes, custom names for apiKey in header). Closes nestjs#3252
This file contains hidden or 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
1 participant
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.
PR Checklist
PR Type
What is the current behavior?
When
@Headers("Authorization")is used alongside bearer auth security, Swagger generates both a security requirement and a redundant header parameter. The header parameter's value isn't sent by Swagger UI, making it confusing.Issue Number: #3252
What is the new behavior?
createDocument()now filters out header parameters whose names match security scheme headers (e.g., "Authorization" for http bearer/basic, custom names for apiKey in header). 6 regression tests added.Does this PR introduce a breaking change?