From c6fbb2d424bfd8b1d0eba3e8998312d20a3d6578 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 28 Oct 2019 09:26:24 -0700 Subject: [PATCH] config/v1/types_cluster_operator: Fix "spec hold the" typo The typo was originally from 898d7e3b7c (api: Move ClusterVersion/ClusterOperator into config.openshift.io, 2018-11-09, #127). The "any operator" bit explains why we don't want, for example, ingress-operator specific config in here. The later ClusterOperatorSpec comment goes into more detail on that with its 'pause' hypothetical, but a bit of extra hinting can't hurt ;). --- ...0000_00_cluster-version-operator_01_clusteroperator.crd.yaml | 2 +- config/v1/types_cluster_operator.go | 2 +- config/v1/zz_generated.swagger_doc_generated.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/config/v1/0000_00_cluster-version-operator_01_clusteroperator.crd.yaml b/config/v1/0000_00_cluster-version-operator_01_clusteroperator.crd.yaml index 918c0f6f8dd..114db5aec88 100644 --- a/config/v1/0000_00_cluster-version-operator_01_clusteroperator.crd.yaml +++ b/config/v1/0000_00_cluster-version-operator_01_clusteroperator.crd.yaml @@ -63,7 +63,7 @@ spec: metadata: type: object spec: - description: spec hold the intent of how this operator should behave. + description: spec holds configuration that could apply to any operator. type: object status: description: status holds the information about the state of an operator. It diff --git a/config/v1/types_cluster_operator.go b/config/v1/types_cluster_operator.go index e4718d59f46..225d9655151 100644 --- a/config/v1/types_cluster_operator.go +++ b/config/v1/types_cluster_operator.go @@ -16,7 +16,7 @@ type ClusterOperator struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata"` - // spec hold the intent of how this operator should behave. + // spec holds configuration that could apply to any operator. // +kubebuilder:validation:Required // +required Spec ClusterOperatorSpec `json:"spec"` diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go index 4ef6e1b69d7..2d6b19d2dd2 100644 --- a/config/v1/zz_generated.swagger_doc_generated.go +++ b/config/v1/zz_generated.swagger_doc_generated.go @@ -378,7 +378,7 @@ func (ImageLabel) SwaggerDoc() map[string]string { var map_ClusterOperator = map[string]string{ "": "ClusterOperator is the Custom Resource object which holds the current state of an operator. This object is used by operators to convey their state to the rest of the cluster.", - "spec": "spec hold the intent of how this operator should behave.", + "spec": "spec holds configuration that could apply to any operator.", "status": "status holds the information about the state of an operator. It is consistent with status information across the Kubernetes ecosystem.", }