fix(middleware): correct documented KeyAuth KeyLookup default#2992
Merged
Conversation
DefaultKeyAuthConfig sets KeyLookup to "header:Authorization:Bearer " in v5, but the KeyAuthConfig.KeyLookup comment still shows the v4 default of "header:Authorization". Update the comment to match. Signed-off-by: leestana01 <leestana01@naver.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2992 +/- ##
==========================================
- Coverage 93.17% 93.17% -0.01%
==========================================
Files 43 43
Lines 4501 4499 -2
==========================================
- Hits 4194 4192 -2
Misses 189 189
Partials 118 118 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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
KeyLookupfield comment inKeyAuthConfigdocuments the default as"header:Authorization", but the default applied byDefaultKeyAuthConfigis:which evaluates to
"header:Authorization:Bearer "(also the valueToMiddlewarefalls back to whenKeyLookupis empty). The:Bearercut-prefix trims the scheme from the header value, exactly as the same comment block describes.The comment was correct in v4, where
AuthScheme: "Bearer"was a separate field. In v5AuthSchemewas folded intoKeyLookup, but this comment was left showing the old default.Doc comment only — no behavior change.