From e078853a8a517d805cbea1a00349ceb35f1fdb91 Mon Sep 17 00:00:00 2001 From: Anik Bhattacharjee Date: Fri, 20 Oct 2023 08:56:55 -0400 Subject: [PATCH] Add GoDoc for Phase (#199) GoDoc for Phase Signed-off-by: Anik Bhattacharjee --- api/core/v1alpha1/catalog_types.go | 4 +++- config/crd/bases/catalogd.operatorframework.io_catalogs.yaml | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/api/core/v1alpha1/catalog_types.go b/api/core/v1alpha1/catalog_types.go index fdb8ebf..7475a25 100644 --- 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 index 3426f13..c237e47 100644 --- 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