-
Notifications
You must be signed in to change notification settings - Fork 68
🐛 Fix API documentation to comply with k8s conventions by fixing embedded field docs and adding missing +optional markers #2409
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this 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
conditionsfield 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 Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Description
PS.: No functional or behavioral changes; documentation and API metadata only.
TL'DR