Fix wrong oauth outbound auth header configuration property name#143
Fix wrong oauth outbound auth header configuration property name#143schaer-bgs wants to merge 1 commit intowso2:mainfrom
Conversation
|
|
WalkthroughThe PR renames Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@all-in-one/values.yaml`:
- Around line 534-535: The existing comment "Remove auth header from outgoing
requests" is stale after renaming removeOutboundAuthHeader to
enableOutboundAuthHeader; update the comment near the enableOutboundAuthHeader
property to describe the current boolean semantics (e.g., "Enable outbound auth
header in outgoing requests" or similar) and change the wording in every file
where the stale comment appears (references: the YAML key
enableOutboundAuthHeader and the old identifier removeOutboundAuthHeader) so the
comment accurately states whether the outbound auth header will be sent when
true/false.
In `@docs/am-pattern-1-all-in-one-HA/default_values.yaml`:
- Around line 419-420: Update the stale comment that mentions the old
removeOutboundAuthHeader semantics to reflect the new property name and meaning:
change the comment above enableOutboundAuthHeader to indicate that it controls
sending the OAuth/auth header to the backend as received from the client (e.g.,
"Send oauth header to the backend as received from the client" or similar).
Apply this change for the enableOutboundAuthHeader comment wherever it appears
across pattern files (previously named removeOutboundAuthHeader) so the comment
matches the README description and the property semantics.
ce35996 to
c68f045
Compare
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/am-pattern-3-ACP_TM_GW/default_gw_values.yaml (1)
320-329:⚠️ Potential issue | 🟡 MinorStale comment doesn't match the renamed property.
Line 322 still says "Remove oauth header from outgoing requests", which describes the old
removeOutboundAuthHeadersemantics. Update it to match the newenableOutboundAuthHeadermeaning, consistent with the updated comment inall-in-one/values.yamland the README description.Proposed fix
# APIM OAuth configurations oauth_config: - # -- Remove oauth header from outgoing requests + # -- Enable outbound auth header in outgoing requests enableOutboundAuthHeader: falsedocs/am-pattern-4-ACP_TM_GW_KM/default_gw_values.yaml (1)
320-329:⚠️ Potential issue | 🟡 MinorStale comment — same issue as in the pattern-3 GW file.
Line 322 still reads "Remove oauth header from outgoing requests". Update to match the new property semantics, e.g., "Enable outbound auth header in outgoing requests".
Proposed fix
# APIM OAuth configurations oauth_config: - # -- Remove oauth header from outgoing requests + # -- Enable outbound auth header in outgoing requests enableOutboundAuthHeader: false
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
New Features
Chores