NO-JIRA: Surface high value enum options in the API docs for oc explain#3289
NO-JIRA: Surface high value enum options in the API docs for oc explain#3289Clee2691 wants to merge 1 commit into
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@Clee2691: This pull request explicitly references no jira issue. DetailsIn response to this:
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. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (9)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (7)
📝 WalkthroughWalkthroughThis PR standardizes and expands documentation strings: Go comments, CRD OpenAPI descriptions, CSV specDescriptors, and reference docs now enumerate valid values for bearer token sources, authentication types, and compression options; some feature-gate notes were clarified or removed; CSV timestamp updated; minor go.mod directive removed. ChangesAPI Documentation and Valid Values Clarification
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@bundle/manifests/observability.openshift.io_clusterlogforwarders.yaml`:
- Around line 3746-3750: The description for the s3.authentication.type enum
incorrectly refers to "cloudwatch authentication"; update the description text
so it refers to S3/AWS authentication (e.g., "Type is the type of S3/AWS
authentication to configure.") in the manifest entry that documents
s3.authentication.type to ensure oc explain displays the correct service name.
In `@config/crd/bases/observability.openshift.io_clusterlogforwarders.yaml`:
- Around line 3746-3750: The description text under the s3 authentication block
incorrectly refers to "cloudwatch authentication"; update the description string
for the s3 auth type (the description field immediately above the enum in the s3
block of the CRD) to reference "S3 authentication" (e.g., "Type is the type of
S3 authentication to configure. Valid values are: awsAccessKey, iamRole.") so oc
explain shows the correct service name.
In `@config/manifests/bases/cluster-logging.clusterserviceversion.yaml`:
- Around line 1773-1777: The description for outputs[0].s3.authentication.type
incorrectly refers to "cloudwatch authentication"; update the YAML so the
description names it as S3 authentication instead (e.g., "Type is the type of S3
authentication to configure. Valid values are: awsAccessKey, iamRole.") by
editing the description string associated with outputs[0].s3.authentication.type
to reference S3 rather than cloudwatch and keep the displayName Authentication
Type unchanged.
In `@docs/reference/operator/api_observability_v1.adoc`:
- Around line 3707-3710: Update the misleading description that currently reads
"cloudwatch authentication" for the S3 auth section: change the text associated
with s3.authentication.type to reference "S3 authentication" instead of
"cloudwatch authentication" and keep the valid values listing (awsAccessKey,
iamRole) intact; ensure the paragraph describing s3.authentication.type clearly
states it configures S3 authentication type and lists the valid values.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3e3cd63d-0f41-4d8b-95a0-4de695898c13
📒 Files selected for processing (9)
.bingo/gen-crd-api-reference-docs.modapi/observability/v1/clusterlogforwarder_types.goapi/observability/v1/output_types.gobundle/manifests/cluster-logging.clusterserviceversion.yamlbundle/manifests/observability.openshift.io_clusterlogforwarders.yamlconfig/crd/bases/observability.openshift.io_clusterlogforwarders.yamlconfig/manifests/bases/cluster-logging.clusterserviceversion.yamldocs/reference/operator/api_logging_v1alpha1.adocdocs/reference/operator/api_observability_v1.adoc
💤 Files with no reviewable changes (1)
- .bingo/gen-crd-api-reference-docs.mod
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Clee2691, jcantrill The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
Bot
added
the
approved
Clee2691
force-pushed
the
add-api-enum-values
branch
from
fc9e16e to
6b2191a
Compare
|
/retest |
|
@Clee2691: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
3 participants
Description
This PR surfaces high value enum options for
oc explain.Namely:
Compressionoptions for different outputsAuthenticationtypes forAzureLogsIngestion&AWSBearerTokenFrom/cc @vparfonov
/assign @jcantrill
Related to #3286
Summary by CodeRabbit