Add GoDoc for Phase (#199)

GoDoc for Phase Signed-off-by: Anik Bhattacharjee <anbhatta@redhat.com>
operator-framework · Oct 20, 2023 · e078853 · e078853
1 parent 0b86f72
commit e078853
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/api/core/v1alpha1/catalog_types.go b/api/core/v1alpha1/catalog_types.go
@@ -84,7 +84,9 @@ type CatalogStatus struct {
 
 	// ResolvedSource contains information about the resolved source
 	ResolvedSource *ResolvedCatalogSource `json:"resolvedSource,omitempty"`
-	Phase          string                 `json:"phase,omitempty"`
+	// Phase represents a human-readable status of resolution of the content source.
+	// It is not appropriate to use for business logic determination.
+	Phase string `json:"phase,omitempty"`
 	// ContentURL is a cluster-internal address that on-cluster components
 	// can read the content of a catalog from
 	ContentURL string `json:"contentURL,omitempty"`

diff --git a/config/crd/bases/catalogd.operatorframework.io_catalogs.yaml b/config/crd/bases/catalogd.operatorframework.io_catalogs.yaml
@@ -164,6 +164,9 @@ spec:
                 format: int64
                 type: integer
               phase:
+                description: Phase represents a human-readable status of resolution
+                  of the content source. It is not appropriate to use for business
+                  logic determination.
                 type: string
               resolvedSource:
                 description: ResolvedSource contains information about the resolved