Skip to content

Replace opaque Step A/B labels in XAA CRD comments#5703

Open
jhrozek wants to merge 1 commit into
mainfrom
xaa-crd-rename-step-ab
Open

Replace opaque Step A/B labels in XAA CRD comments#5703
jhrozek wants to merge 1 commit into
mainfrom
xaa-crd-rename-step-ab

Conversation

@jhrozek

@jhrozek jhrozek commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

The XAASpec struct comments and the generated CRD YAML descriptions used
"Step A" and "Step B" to refer to the two phases of the ID-JAG protocol.
These labels are opaque — they tell the reader nothing about what each step
does or which endpoint it targets, and they're easy to confuse with each
other.

Replace them throughout with action-oriented names:

  • IdP exchange — RFC 8693 token exchange at the user's IdP; produces the ID-JAG JWT
  • target grant — RFC 7523 JWT bearer grant at the target AS; produces the backend access token

The rename covers the ExternalAuthTypeXAA const comment, the XAASpec
type comment, and every field description that referenced the old labels
(IDPTokenURL, IDPClientID, TargetTokenURL, TargetClientID,
TargetResource, Scopes, SubjectTokenType). CRD YAML regenerated with
task operator-manifests.

Type of change

  • Documentation update (no production code change)

Test plan

  • task operator-manifests ran cleanly; generated YAML contains zero occurrences of "Step A" or "Step B"
  • Verified with grep -c "Step A\|Step B" on generated YAML: output 0

Generated with Claude Code

"Step A" and "Step B" in the XAASpec struct comments and the generated
CRD YAML descriptions don't tell the reader what each step does or which
endpoint it targets. Rename throughout to "IdP exchange" (RFC 8693 token
exchange at the user's IdP, produces the ID-JAG) and "target grant"
(RFC 7523 JWT bearer grant at the target AS, produces the backend access
token). Regenerate the CRD YAML with task operator-manifests.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added the size/XS Extra small PR: < 100 lines changed label Jul 1, 2026
@codecov

codecov Bot commented Jul 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.65%. Comparing base (2aca563) to head (33ad545).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5703      +/-   ##
==========================================
+ Coverage   70.61%   70.65%   +0.03%     
==========================================
  Files         667      667              
  Lines       67607    67607              
==========================================
+ Hits        47743    47765      +22     
+ Misses      16410    16373      -37     
- Partials     3454     3469      +15     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Extra small PR: < 100 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant