Skip to content

Conversation

@camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Dec 24, 2025

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

Copilot AI review requested due to automatic review settings December 24, 2025 11:04
@camilamacedo86 camilamacedo86 requested a review from a team as a code owner December 24, 2025 11:04
@openshift-ci openshift-ci bot requested review from dtfranz and oceanc80 December 24, 2025 11:04
@openshift-ci
Copy link

openshift-ci bot commented Dec 24, 2025

[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 camilamacedo86 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:

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

@netlify
Copy link

netlify bot commented Dec 24, 2025

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...

QR Code

Use your smartphone camera to open QR code link.

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

@camilamacedo86 camilamacedo86 changed the title (fix) Api documentation 📖 (fix) Api documentation Dec 24, 2025
@camilamacedo86 camilamacedo86 changed the title 📖 (fix) Api documentation 📖 (fix) Api documentation kube-api-linter check Dec 24, 2025
@camilamacedo86 camilamacedo86 changed the title 📖 (fix) Api documentation kube-api-linter check 🐛 (fix) Api documentation kube-api-linter check Dec 24, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@camilamacedo86 camilamacedo86 changed the title 🐛 (fix) Api documentation kube-api-linter check 🐛 (fix) API documentation to comply with k8s conventions by fixing embedded field docs and adding missing +optional markers Dec 24, 2025
@codecov
Copy link

codecov bot commented Dec 24, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.06%. Comparing base (578dc33) to head (2954109).
⚠️ Report is 6 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.

@camilamacedo86 camilamacedo86 changed the title 🐛 (fix) API documentation to comply with k8s conventions by fixing embedded field docs and adding missing +optional markers 🐛 Fix API documentation to comply with k8s conventions by fixing embedded field docs and adding missing +optional markers Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant