update descriptions

Signed-off-by: Christian Groschupp <[email protected]>
opensearch-project · Feb 27, 2024 · d55bdf4 · d55bdf4
1 parent f5b16ca
commit d55bdf4
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/opensearch-operator/api/v1/opensearch_index_types.go b/opensearch-operator/api/v1/opensearch_index_types.go
@@ -5,10 +5,12 @@ import (
 )
 
 type OpensearchDatastreamTimestampFieldSpec struct {
+	// Name of the field that are used for the DataStream
 	Name string `json:"name"`
 }
 
 type OpensearchDatastreamSpec struct {
+	// TimestampField for dataStream
 	TimestampField OpensearchDatastreamTimestampFieldSpec `json:"timestamp_field,omitempty"`
 }
 

diff --git a/opensearch-operator/api/v1/opensearch_indextemplate_types.go b/opensearch-operator/api/v1/opensearch_indextemplate_types.go
@@ -48,7 +48,7 @@ type OpensearchIndexTemplateSpec struct {
 	// Array of wildcard expressions used to match the names of indices during creation
 	IndexPatterns []string `json:"indexPatterns"`
 
-	// Array of wildcard expressions used to match the names of indices during creation
+	// The dataStream config that should be applied
 	DataStream *OpensearchDatastreamSpec `json:"dataStream,omitempty"`
 
 	// The template that should be applied

diff --git a/opensearch-operator/config/crd/bases/opensearch.opster.io_opensearchindextemplates.yaml b/opensearch-operator/config/crd/bases/opensearch.opster.io_opensearchindextemplates.yaml
@@ -48,12 +48,13 @@ spec:
                   type: string
                 type: array
               dataStream:
-                description: Array of wildcard expressions used to match the names
-                  of indices during creation
+                description: The dataStream config that should be applied
                 properties:
                   timestamp_field:
+                    description: TimestampField for dataStream
                     properties:
                       name:
+                        description: Name of the field that are used for the DataStream
                         type: string
                     required:
                     - name

diff --git a/opensearch-operator/pkg/helpers/translate.go b/opensearch-operator/pkg/helpers/translate.go
@@ -38,6 +38,7 @@ func TranslateComponentTemplateToRequest(spec v1.OpensearchComponentTemplateSpec
 	return request
 }
 
+// TranslateDatastreamToRequest rewrites the CRD format to the gateway format
 func TranslateDatastreamToRequest(spec *v1.OpensearchDatastreamSpec) *requests.Datastream {
 	if spec == nil {
 		return nil