Skip to content

Commit b0e0d65

Browse files
Fix commentstart linter doc check
1 parent c565f79 commit b0e0d65

File tree

9 files changed

+18
-10
lines changed

9 files changed

+18
-10
lines changed

api/v1/clusterextension_types.go

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ type RevisionStatus struct {
474474

475475
// ClusterExtensionStatus defines the observed state of a ClusterExtension.
476476
type ClusterExtensionStatus struct {
477-
// The set of condition types which apply to all spec.source variations are Installed and Progressing.
477+
// conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
478478
//
479479
// The Installed condition represents whether the bundle has been installed for this ClusterExtension:
480480
// - When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.
@@ -536,7 +536,11 @@ type ClusterExtensionInstallStatus struct {
536536

537537
// ClusterExtension is the Schema for the clusterextensions API
538538
type ClusterExtension struct {
539-
metav1.TypeMeta `json:",inline"`
539+
metav1.TypeMeta `json:",inline"`
540+
541+
// metadata is the standard object's metadata.
542+
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
543+
// +optional
540544
metav1.ObjectMeta `json:"metadata,omitempty"`
541545

542546
// spec is an optional field that defines the desired state of the ClusterExtension.

api/v1/clusterextensionrevision_types.go

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,11 @@ type ClusterExtensionRevisionStatus struct {
218218
// or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
219219
// posterity.
220220
type ClusterExtensionRevision struct {
221-
metav1.TypeMeta `json:",inline"`
221+
metav1.TypeMeta `json:",inline"`
222+
223+
// metadata is the standard object's metadata.
224+
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
225+
// +optional
222226
metav1.ObjectMeta `json:"metadata,omitempty"`
223227

224228
// spec defines the desired state of the ClusterExtensionRevision.

docs/api-reference/olmv1-api-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ _Appears in:_
359359

360360
| Field | Description | Default | Validation |
361361
| --- | --- | --- | --- |
362-
| `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. | | |
362+
| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta) array_ | conditions represents 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. | | |
363363
| `install` _[ClusterExtensionInstallStatus](#clusterextensioninstallstatus)_ | install is a representation of the current installation status for this ClusterExtension. | | |
364364
| `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> | | |
365365

helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ spec:
576576
x-kubernetes-list-type: map
577577
conditions:
578578
description: |-
579-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
579+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
580580
581581
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
582582
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ spec:
456456
properties:
457457
conditions:
458458
description: |-
459-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
459+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
460460
461461
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
462462
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

manifests/experimental-e2e.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1462,7 +1462,7 @@ spec:
14621462
x-kubernetes-list-type: map
14631463
conditions:
14641464
description: |-
1465-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
1465+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
14661466
14671467
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
14681468
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

manifests/experimental.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1423,7 +1423,7 @@ spec:
14231423
x-kubernetes-list-type: map
14241424
conditions:
14251425
description: |-
1426-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
1426+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
14271427
14281428
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
14291429
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

manifests/standard-e2e.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1067,7 +1067,7 @@ spec:
10671067
properties:
10681068
conditions:
10691069
description: |-
1070-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
1070+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
10711071
10721072
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
10731073
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

manifests/standard.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1028,7 +1028,7 @@ spec:
10281028
properties:
10291029
conditions:
10301030
description: |-
1031-
The set of condition types which apply to all spec.source variations are Installed and Progressing.
1031+
conditions represents the set of condition types which apply to all spec.source variations are Installed and Progressing.
10321032
10331033
The Installed condition represents whether the bundle has been installed for this ClusterExtension:
10341034
- When Installed is True and the Reason is Succeeded, the bundle has been successfully installed.

0 commit comments

Comments
 (0)