🐛 Fix API documentation to comply with k8s conventions by fixing embedded field docs and adding missing +optional markers

[camilamacedo86]

Description

• Updated API documentation comments to conform to Kubernetes API conventions.
• Fixed documentation for embedded fields (e.g., ObjectMeta) so they render correctly in generated API docs.
• Added missing +optional markers to API fields to satisfy kube-api-linter requirements.

PS.: No functional or behavioral changes; documentation and API metadata only.

TL'DR

=== FIXED ISSUES ===
api/v1/clusterextension_types.go:477:2:kubeapilinter:commentstart: godoc for field ClusterExtensionStatus.Conditions should start with 'conditions ...'
api/v1/clusterextension_types.go:540:2:kubeapilinter:commentstart: field ClusterExtension.metav1.ObjectMeta is missing godoc comment
api/v1/clusterextensionrevision_types.go:219:2:kubeapilinter:commentstart: field ClusterExtensionRevision.metav1.ObjectMeta is missing godoc comment
=== HOW ===
1. api/v1/clusterextension_types.go:477 - ClusterExtensionStatus.Conditions godoc formatting
Fixed godoc comment to start with 'conditions' instead of custom text
2. api/v1/clusterextension_types.go:540 - ClusterExtension.metav1.ObjectMeta missing godoc
Added godoc comment for the embedded ObjectMeta field
3. api/v1/clusterextensionrevision_types.go:219 - ClusterExtensionRevision.metav1.ObjectMeta missing godoc
Added godoc comment for the embedded ObjectMeta field

[netlify]

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	2954109
🔍 Latest deploy log	https://app.netlify.com/projects/olmv1/deploys/694bc8ca4e7a930008467652
😎 Deploy Preview	https://deploy-preview-2409--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

Pull request overview

This PR enhances the API documentation for ClusterExtension-related resources by adding introductory descriptions to key fields. The changes improve clarity by providing context at the start of field documentation before diving into detailed specifications.

Key changes:

• Added introductory documentation to the conditions field in ClusterExtensionStatus explaining it represents the current state
• Added standard metadata field documentation to ClusterExtension and ClusterExtensionRevision types

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
api/v1/clusterextension_types.go	Added documentation for the conditions field and metadata field in ClusterExtension type
api/v1/clusterextensionrevision_types.go	Added standard metadata field documentation to ClusterExtensionRevision type
manifests/standard.yaml	Updated CRD with conditions field documentation
manifests/standard-e2e.yaml	Updated e2e manifest with conditions field documentation
manifests/experimental.yaml	Updated experimental CRD with conditions field documentation
manifests/experimental-e2e.yaml	Updated experimental e2e manifest with conditions field documentation
helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml	Updated standard helm CRD with conditions field documentation
helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml	Updated experimental helm CRD with conditions field documentation
docs/api-reference/olmv1-api-reference.md	Updated API reference documentation to include the new introductory text for conditions field

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.06%. Comparing base (578dc33) to head (2954109).
⚠️ Report is 21 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #2409 +/- ##
==========================================
+ Coverage 68.82% 73.06% +4.24% 
==========================================
Files 100 100 Lines 7641 7641 ==========================================
+ Hits 5259 5583 +324 + Misses 1947 1621 -326 - Partials 435 437 +2 

Flag	Coverage Δ
e2e	44.01% <ø> (+0.07%)	⬆️
experimental-e2e	48.68% <ø> (+35.00%)	⬆️
unit	57.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

[pedjak]

/lgtm

[camilamacedo86]

@tmshort could you please help us to bypass the crd-diff in this case?

[tmshort]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tmshort

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• api/OWNERS [tmshort]
• docs/OWNERS [tmshort]
• helm/OWNERS [tmshort]
• manifests/OWNERS [tmshort]

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

[tmshort]

/override crd-diff

[openshift-ci]

@tmshort: Overrode contexts on behalf of tmshort: crd-diff

Details

In response to this:

/override crd-diff

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.

[tmshort]

/override crd-diff/crd-diff

[openshift-ci]

@tmshort: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

• crd-diff/crd-diff

Only the following failed contexts/checkruns were expected:

• Autovalidate
• Verify PR title
• crd-diff
• e2e
• experimental-e2e
• extension-developer-e2e
• go-apidiff
• go-verdiff
• goreleaser
• lint
• netlify/olmv1/deploy-preview
• st2ex-e2e
• tide
• unit-test-basic
• upgrade-st2st-e2e
• verify

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

Details

In response to this:

/override crd-diff/crd-diff

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.