(fix) Api documentation

camilamacedo86 · camilamacedo86 · commit 2954109ce187 · 2025-12-24T11:03:24.000Z
diff --git a/api/v1/clusterextension_types.go b/api/v1/clusterextension_types.go
@@ -474,6 +474,8 @@ type RevisionStatus struct {
 
 // ClusterExtensionStatus defines the observed state of a ClusterExtension.
 type ClusterExtensionStatus struct {
+	// conditions represents the current state of the ClusterExtension.
+	//
 	// The set of condition types which apply to all spec.source variations are Installed and Progressing.
 	//
 	// The Installed condition represents whether the bundle has been installed for this ClusterExtension:
@@ -536,7 +538,11 @@ type ClusterExtensionInstallStatus struct {
 
 // ClusterExtension is the Schema for the clusterextensions API
 type ClusterExtension struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+
+	// metadata is the standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec is an optional field that defines the desired state of the ClusterExtension.
diff --git a/api/v1/clusterextensionrevision_types.go b/api/v1/clusterextensionrevision_types.go
@@ -215,7 +215,11 @@ type ClusterExtensionRevisionStatus struct {
 // or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
 // posterity.
 type ClusterExtensionRevision struct {
-	metav1.TypeMeta   `json:",inline"`
+	metav1.TypeMeta `json:",inline"`
+
+	// metadata is the standard object's metadata.
+	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+	// +optional
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// spec defines the desired state of the ClusterExtensionRevision.
diff --git a/docs/api-reference/olmv1-api-reference.md b/docs/api-reference/olmv1-api-reference.md
@@ -359,7 +359,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | The set of condition types which apply to all spec.source variations are Installed and Progressing.<br />The Installed condition represents whether the bundle has been installed for this ClusterExtension:<br />  - When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.<br />  - When Installed is False and the Reason is Failed, the bundle has failed to install.<br />The Progressing condition represents whether or not the ClusterExtension is advancing towards a new state.<br />When Progressing is True and the Reason is Succeeded, the ClusterExtension is making progress towards a new state.<br />When Progressing is True and the Reason is Retrying, the ClusterExtension has encountered an error that could be resolved on subsequent reconciliation attempts.<br />When Progressing is False and the Reason is Blocked, the ClusterExtension has encountered an error that requires manual intervention for recovery.<br /><opcon:experimental:description><br />When Progressing is True and Reason is RollingOut, the ClusterExtension has one or more ClusterExtensionRevisions in active roll out.<br /></opcon:experimental:description><br />When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition.<br />These are indications from a package owner to guide users away from a particular package, channel, or bundle:<br />  - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog.<br />  - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog.<br />  - PackageDeprecated is set if the requested package is marked deprecated in the catalog.<br />  - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. |  |  |
+| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | conditions represents the current state of the ClusterExtension.<br />The set of condition types which apply to all spec.source variations are Installed and Progressing.<br />The Installed condition represents whether the bundle has been installed for this ClusterExtension:<br />  - When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.<br />  - When Installed is False and the Reason is Failed, the bundle has failed to install.<br />The Progressing condition represents whether or not the ClusterExtension is advancing towards a new state.<br />When Progressing is True and the Reason is Succeeded, the ClusterExtension is making progress towards a new state.<br />When Progressing is True and the Reason is Retrying, the ClusterExtension has encountered an error that could be resolved on subsequent reconciliation attempts.<br />When Progressing is False and the Reason is Blocked, the ClusterExtension has encountered an error that requires manual intervention for recovery.<br /><opcon:experimental:description><br />When Progressing is True and Reason is RollingOut, the ClusterExtension has one or more ClusterExtensionRevisions in active roll out.<br /></opcon:experimental:description><br />When the ClusterExtension is sourced from a catalog, it may also communicate a deprecation condition.<br />These are indications from a package owner to guide users away from a particular package, channel, or bundle:<br />  - BundleDeprecated is set if the requested bundle version is marked deprecated in the catalog.<br />  - ChannelDeprecated is set if the requested channel is marked deprecated in the catalog.<br />  - PackageDeprecated is set if the requested package is marked deprecated in the catalog.<br />  - Deprecated is a rollup condition that is present when any of the deprecated conditions are present. |  |  |
 | `install` _[ClusterExtensionInstallStatus](#clusterextensioninstallstatus)_ | install is a representation of the current installation status for this ClusterExtension. |  |  |
 | `activeRevisions` _[RevisionStatus](#revisionstatus) array_ | activeRevisions holds a list of currently active (non-archived) ClusterExtensionRevisions,<br />including both installed and rolling out revisions.<br /><opcon:experimental> |  |  |
 
diff --git a/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml b/helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml
@@ -576,6 +576,8 @@ spec:
                 x-kubernetes-list-type: map
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
diff --git a/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml b/helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml
@@ -456,6 +456,8 @@ spec:
             properties:
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
diff --git a/manifests/experimental-e2e.yaml b/manifests/experimental-e2e.yaml
@@ -1461,6 +1461,8 @@ spec:
                 x-kubernetes-list-type: map
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
diff --git a/manifests/experimental.yaml b/manifests/experimental.yaml
@@ -1422,6 +1422,8 @@ spec:
                 x-kubernetes-list-type: map
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
diff --git a/manifests/standard-e2e.yaml b/manifests/standard-e2e.yaml
@@ -1066,6 +1066,8 @@ spec:
             properties:
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
diff --git a/manifests/standard.yaml b/manifests/standard.yaml
@@ -1027,6 +1027,8 @@ spec:
             properties:
               conditions:
                 description: |-
+                  conditions represents the current state of the ClusterExtension.
+
                   The set of condition types which apply to all spec.source variations are Installed and Progressing.
 
                   The Installed condition represents whether the bundle has been installed for this ClusterExtension:
