OCPBUGS-56851: make multiline comments for oidc one line for better crd gen and better oc explain description format

[ehearne-redhat]

This change specifically targets OIDC-specific comments to ensure oc explain, based on CRD generation, will render the Description field in an optimal format i.e. no disjointed lines.

[openshift-ci-robot]

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

[openshift-ci]

Hello @ehearne-redhat! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

[openshift-ci-robot]

@ehearne-redhat: This pull request references Jira Issue OCPBUGS-56851, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.22.0) matches configured target version for branch (4.22.0)
• bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @xingxingxia

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

This change specifically targets OIDC-specific comments to ensure oc explain, based on CRD generation, will render the Description field in an optimal format i.e. no disjointed lines.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates documentation and comments in config/v1/types_authentication.go. Changes refine prose, standardize phrasing, and clarify field descriptions for OIDC-related types. Updates include merging scattered comment lines, removing redundant phrasing, and adjusting inline comments for fields such as issuer, discoveryURL, prefixPolicy, and UID/claims mappings. No structural changes are made to exported types, public method signatures, or validation rules. The net change is 62 additions and 115 deletions, affecting only comment and documentation text.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: converting multiline OIDC comments to single-line format for improved CRD generation and oc explain output formatting.
Description check	✅ Passed	The description is directly related to the changeset, explaining the purpose of converting multiline OIDC comments to single-line format for optimal oc explain description rendering.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 28a3711 and fcb97da.

📒 Files selected for processing (1)

• config/v1/types_authentication.go

🔇 Additional comments (10)

config/v1/types_authentication.go (10)

202-250: Doc updates for OIDCProvider are clear and consistent.
The single-line phrasing should render well in CRD/oc explain.

---

258-307: TokenIssuer documentation reads cleanly after consolidation.
No concerns with the comment refinements.

---

311-349: TokenClaimMappings wording is crisp and more readable.
Looks good for CRD/oc explain output.

---

472-523: OIDCClientConfig comment cleanup looks good.
No functional impact; wording is clearer.

---

530-568: OIDCClientStatus documentation is improved.
Single-line style should avoid broken oc explain output.

---

587-609: OIDCClientReference docs are consistent and concise.
No issues.

---

615-656: UsernameClaimMapping explanations are clearer and more compact.
Nice improvement for generated docs.

---

659-661: UsernamePrefixPolicy summary line is straightforward.
No concerns.

---

736-744: TokenClaimValidationRule wording is tighter and consistent.
LGTM.

---

799-810: TokenUserValidationRule comments read well after edits.
No changes requested.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.5.0)

Error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented
The command is terminated due to an error: build linters: unable to load custom analyzer "kubeapilinter": tools/_output/bin/kube-api-linter.so, plugin: not implemented

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign deads2k for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ehearne-redhat]

@ShazaAldawamneh could you review when you have the chance? :)

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@config/v1/types_authentication.go`:
- Around line 293-296: Update the comment that currently says "must differ from
the value of `url`" to reference `issuerURL` instead so it matches the JSON
field name and existing validation message; locate the block describing
discoveryURL (identifier: discoveryURL) and replace `url` with `issuerURL` to
keep the docstring consistent with issuerURL/validation text.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 36664f7 and 28a3711.

📒 Files selected for processing (1)

• config/v1/types_authentication.go

🧰 Additional context used

🧬 Code graph analysis (1)

config/v1/types_authentication.go (1)

config/v1/zz_generated.swagger_doc_generated.go (8)

• TokenIssuer (525-527)
• TokenClaimMappings (484-486)
• TokenClaimValidationRule (514-516)
• ConfigMapNameReference (86-88)
• UsernameClaimMapping (554-556)
• PrefixedClaimMapping (464-466)
• TokenClaimOrExpressionMapping (494-496)
• SecretNameReference (230-232)

🔇 Additional comments (8)

config/v1/types_authentication.go (8)

201-251: LGTM!

The comment reformatting for the OIDCProvider struct fields successfully consolidates the multiline descriptions into single-line comments. This will improve oc explain output formatting as intended.

---

310-350: LGTM!

The reformatted comments for TokenClaimMappings fields (username, groups, uid, extra) are clear and maintain the original semantic meaning while achieving the single-line format goal.

---

468-524: LGTM!

The OIDCClientConfig struct field comments are well-reformatted. The descriptions for componentName, componentNamespace, clientID, clientSecret, and extraScopes remain clear and informative.

---

526-582: LGTM!

The OIDCClientStatus struct comments are properly reformatted to single-line style while maintaining clarity.

---

584-610: LGTM!

The OIDCClientReference struct field comments are correctly reformatted.

---

612-661: LGTM!

The UsernameClaimMapping and UsernamePrefixPolicy documentation changes properly consolidate the multiline descriptions while preserving the detailed examples and behavior documentation for prefix handling.

---

731-753: LGTM!

The TokenClaimValidationRule struct comments are properly reformatted. The descriptions for the type and requiredClaim fields remain clear.

---

796-816: LGTM!

The TokenUserValidationRule struct comments are properly reformatted to single-line format.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[ehearne-redhat]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[openshift-ci]

@ehearne-redhat: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/verify	fcb97da	link	true	/test verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.