update type comments

Signed-off-by: everettraven <everettraven@gmail.com>
operator-framework · May 14, 2024 · 5e073d6 · 5e073d6
1 parent ef639c8
commit 5e073d6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/api/core/v1alpha1/clustercatalog_types.go b/api/core/v1alpha1/clustercatalog_types.go
@@ -50,7 +50,7 @@ const (
 //+kubebuilder:printcolumn:name="Phase",type=string,JSONPath=`.status.phase`
 //+kubebuilder:printcolumn:name=Age,type=date,JSONPath=`.metadata.creationTimestamp`
 
-// ClusterCatalog is the Schema for the Catalogs API
+// ClusterCatalog is the Schema for the ClusterCatalogs API
 type ClusterCatalog struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -61,25 +61,25 @@ type ClusterCatalog struct {
 
 //+kubebuilder:object:root=true
 
-// ClusterCatalogList contains a list of Catalog
+// ClusterCatalogList contains a list of ClusterCatalog
 type ClusterCatalogList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
 
 	Items []ClusterCatalog `json:"items"`
 }
 
-// ClusterCatalogSpec defines the desired state of Catalog
+// ClusterCatalogSpec defines the desired state of ClusterCatalog
 // +kubebuilder:validation:XValidation:rule="!has(self.source.image.pollInterval) || (self.source.image.ref.find('@sha256:') == \"\")",message="cannot specify PollInterval while using digest-based image"
 type ClusterCatalogSpec struct {
 	// Source is the source of a Catalog that contains Operators' metadata in the FBC format
 	// https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
 	Source CatalogSource `json:"source"`
 }
 
-// ClusterCatalogStatus defines the observed state of Catalog
+// ClusterCatalogStatus defines the observed state of ClusterCatalog
 type ClusterCatalogStatus struct {
-	// Conditions store the status conditions of the Catalog instances
+	// Conditions store the status conditions of the ClusterCatalog instances
 	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
 
 	// ResolvedSource contains information about the resolved source
@@ -90,8 +90,8 @@ type ClusterCatalogStatus struct {
 	// ContentURL is a cluster-internal address that on-cluster components
 	// can read the content of a catalog from
 	ContentURL string `json:"contentURL,omitempty"`
-	// observedGeneration is the most recent generation observed for this Catalog. It corresponds to the
-	// Catalog's generation, which is updated on mutation by the API Server.
+	// observedGeneration is the most recent generation observed for this ClusterCatalog. It corresponds to the
+	// ClusterCatalog's generation, which is updated on mutation by the API Server.
 	// +optional
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }

diff --git a/config/crd/bases/catalogd.operatorframework.io_clustercatalogs.yaml b/config/crd/bases/catalogd.operatorframework.io_clustercatalogs.yaml
@@ -24,7 +24,7 @@ spec:
     name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: ClusterCatalog is the Schema for the Catalogs API
+        description: ClusterCatalog is the Schema for the ClusterCatalogs API
         properties:
           apiVersion:
             description: |-
@@ -44,7 +44,7 @@ spec:
           metadata:
             type: object
           spec:
-            description: ClusterCatalogSpec defines the desired state of Catalog
+            description: ClusterCatalogSpec defines the desired state of ClusterCatalog
             properties:
               source:
                 description: |-
@@ -96,10 +96,10 @@ spec:
               rule: '!has(self.source.image.pollInterval) || (self.source.image.ref.find(''@sha256:'')
                 == "")'
           status:
-            description: ClusterCatalogStatus defines the observed state of Catalog
+            description: ClusterCatalogStatus defines the observed state of ClusterCatalog
             properties:
               conditions:
-                description: Conditions store the status conditions of the Catalog
+                description: Conditions store the status conditions of the ClusterCatalog
                   instances
                 items:
                   description: "Condition contains details for one aspect of the current
@@ -176,8 +176,8 @@ spec:
                 type: string
               observedGeneration:
                 description: |-
-                  observedGeneration is the most recent generation observed for this Catalog. It corresponds to the
-                  Catalog's generation, which is updated on mutation by the API Server.
+                  observedGeneration is the most recent generation observed for this ClusterCatalog. It corresponds to the
+                  ClusterCatalog's generation, which is updated on mutation by the API Server.
                 format: int64
                 type: integer
               phase: