adapt docs

Signed-off-by: odubajDT <ondrej.dubaj@dynatrace.com>
keptn · Sep 20, 2023 · 75b4999 · 75b4999
1 parent 4401685
commit 75b4999
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/.github/scripts/.helm-tests/default/result.yaml b/.github/scripts/.helm-tests/default/result.yaml
@@ -245,7 +245,7 @@ spec:
                 description: Raw contains the raw result of the SLO computation
                 type: string
               state:
-                description: State describes the current state of the Analysis
+                description: State describes the current state of the Analysis (Pending/Progressing/Completed)
                 type: string
               storedValues:
                 additionalProperties:

diff --git a/docs/content/en/docs/crd-ref/metrics/v1alpha3/_index.md b/docs/content/en/docs/crd-ref/metrics/v1alpha3/_index.md
@@ -150,7 +150,7 @@ _Appears in:_
 | `raw` _string_ | Raw contains the raw result of the SLO computation |
 | `pass` _boolean_ | Pass returns whether the SLO is satisfied |
 | `warning` _boolean_ | Warning returns whether the analysis returned a warning |
-| `state` _[AnalysisState](#analysisstate)_ | State describes the current state of the Analysis |
+| `state` _[AnalysisState](#analysisstate)_ | State describes the current state of the Analysis (Pending/Progressing/Completed) |
 | `storedValues` _object (keys:string, values:[ProviderResult](#providerresult))_ | StoredValues contains all analysis values that have already been retrieved successfully |
 
 

diff --git a/helm/chart/templates/analysis-crd.yaml b/helm/chart/templates/analysis-crd.yaml
@@ -106,7 +106,7 @@ spec:
                 description: Raw contains the raw result of the SLO computation
                 type: string
               state:
-                description: State describes the current state of the Analysis
+                description: State describes the current state of the Analysis (Pending/Progressing/Completed)
                 type: string
               storedValues:
                 additionalProperties:

diff --git a/metrics-operator/api/v1alpha3/analysis_types.go b/metrics-operator/api/v1alpha3/analysis_types.go
@@ -48,7 +48,7 @@ type AnalysisStatus struct {
 	Pass bool `json:"pass,omitempty"`
 	// Warning returns whether the analysis returned a warning
 	Warning bool `json:"warning,omitempty"`
-	// State describes the current state of the Analysis
+	// State describes the current state of the Analysis (Pending/Progressing/Completed)
 	State AnalysisState `json:"state"`
 	// StoredValues contains all analysis values that have already been retrieved successfully
 	StoredValues map[string]ProviderResult `json:"storedValues,omitempty"`

diff --git a/metrics-operator/config/crd/bases/metrics.keptn.sh_analyses.yaml b/metrics-operator/config/crd/bases/metrics.keptn.sh_analyses.yaml
@@ -101,7 +101,7 @@ spec:
                 description: Raw contains the raw result of the SLO computation
                 type: string
               state:
-                description: State describes the current state of the Analysis
+                description: State describes the current state of the Analysis (Pending/Progressing/Completed)
                 type: string
               storedValues:
                 additionalProperties: