chore: mark kafka include-headers as experimental (#1570)

Signed-off-by: Vigith Maurice <[email protected]>
numaproj · Mar 15, 2024 · 9fa339e · 9fa339e
1 parent 4457ac8
commit 9fa339e
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 4 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -18850,7 +18850,7 @@
           "type": "string"
         },
         "includeHeaders": {
-          "description": "include Kafka headers (this will change the payload struct into a JSON format with _body and _headers)",
+          "description": "include Kafka headers (this will change the payload struct into a JSON format with _body and _headers) EXPERIMENTAL: We might remove this option later on (https://github.com/numaproj/numaflow/issues/1568)",
           "type": "boolean"
         },
         "sasl": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -18849,7 +18849,7 @@
           "type": "string"
         },
         "includeHeaders": {
-          "description": "include Kafka headers (this will change the payload struct into a JSON format with _body and _headers)",
+          "description": "include Kafka headers (this will change the payload struct into a JSON format with _body and _headers) EXPERIMENTAL: We might remove this option later on (https://github.com/numaproj/numaflow/issues/1568)",
           "type": "boolean"
         },
         "sasl": {

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -2792,7 +2792,9 @@ default for SASL.
 <em>(Optional)</em>
 <p>
 include Kafka headers (this will change the payload struct into a JSON
-format with \_body and \_headers)
+format with \_body and \_headers) EXPERIMENTAL: We might remove this
+option later on
+(<a href="https://github.com/numaproj/numaflow/issues/1568">https://github.com/numaproj/numaflow/issues/1568</a>)
 </p>
 </td>
 </tr>

diff --git a/pkg/apis/numaflow/v1alpha1/generated.proto b/pkg/apis/numaflow/v1alpha1/generated.proto
diff --git a/pkg/apis/numaflow/v1alpha1/kafka_source.go b/pkg/apis/numaflow/v1alpha1/kafka_source.go
@@ -31,6 +31,7 @@ type KafkaSource struct {
 	// +optional
 	SASL *SASL `json:"sasl" protobuf:"bytes,6,opt,name=sasl"`
 	// include Kafka headers (this will change the payload struct into a JSON format with _body and _headers)
+	// EXPERIMENTAL: We might remove this option later on (https://github.com/numaproj/numaflow/issues/1568)
 	// +optional
 	IncludeHeaders bool `json:"includeHeaders" protobuf:"bytes,7,opt,name=includeHeaders"`
 }
diff --git a/pkg/apis/numaflow/v1alpha1/openapi_generated.go b/pkg/apis/numaflow/v1alpha1/openapi_generated.go