Highlight base64 requirement for secret data (#1496)

redpanda-data · Nov 5, 2024 · 2e2c0fb · 2e2c0fb
1 parent 2aa0ff4
commit 2e2c0fb
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 18 deletions.
diff --git a/backend/pkg/protogen/redpanda/api/dataplane/v1alpha2/secret.pb.go b/backend/pkg/protogen/redpanda/api/dataplane/v1alpha2/secret.pb.go
diff --git a/frontend/src/protogen/redpanda/api/dataplane/v1alpha2/secret_pb.ts b/frontend/src/protogen/redpanda/api/dataplane/v1alpha2/secret_pb.ts
@@ -359,7 +359,7 @@ export class CreateSecretRequest extends Message<CreateSecretRequest> {
   scopes: Scope[] = [];
 
   /**
-   * The secret data.
+   * The secret data. Must be Base64-encoded.
    *
    * @generated from field: bytes secret_data = 4;
    */
@@ -465,7 +465,7 @@ export class UpdateSecretRequest extends Message<UpdateSecretRequest> {
   scopes: Scope[] = [];
 
   /**
-   * The secret data.
+   * The secret data. Must be Base64-encoded.
    *
    * @generated from field: bytes secret_data = 4;
    */
@@ -735,7 +735,7 @@ export class CreateConnectSecretRequest extends Message<CreateConnectSecretReque
   labels: { [key: string]: string } = {};
 
   /**
-   * The secret data.
+   * The secret data. Must be Base64-encoded.
    *
    * @generated from field: bytes secret_data = 4;
    */
@@ -956,7 +956,7 @@ export class UpdateConnectSecretRequest extends Message<UpdateConnectSecretReque
   labels: { [key: string]: string } = {};
 
   /**
-   * The secret data.
+   * The secret data. Must be Base64-encoded.
    *
    * @generated from field: bytes secret_data = 4;
    */

diff --git a/package-lock.json b/package-lock.json
diff --git a/proto/gen/openapi/openapi.json b/proto/gen/openapi/openapi.json
diff --git a/proto/gen/openapi/openapi.yaml b/proto/gen/openapi/openapi.yaml
@@ -332,7 +332,7 @@ components:
           title: Secret scopes
           type: array
         secret_data:
-          description: The secret data.
+          description: The secret data. Must be Base64-encoded.
           format: byte
           type: string
       required:
@@ -2477,7 +2477,7 @@ paths:
                   description: Name of connector.
                   type: string
                 secret_data:
-                  description: The secret data.
+                  description: The secret data. Must be Base64-encoded.
                   format: byte
                   type: string
               required:
@@ -2642,7 +2642,7 @@ paths:
                   description: Secret labels.
                   type: object
                 secret_data:
-                  description: The secret data.
+                  description: The secret data. Must be Base64-encoded.
                   format: byte
                   type: string
               required:
@@ -3247,7 +3247,7 @@ paths:
                   title: Secret scopes
                   type: array
                 secret_data:
-                  description: The secret data.
+                  description: The secret data. Must be Base64-encoded.
                   format: byte
                   type: string
               required:
@@ -3663,7 +3663,7 @@ paths:
         content:
           multipart/form-data:
             schema:
-              example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
+              example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
               properties:
                 metadata:
                   $ref: '#/components/schemas/DeployTransformRequest'

diff --git a/proto/redpanda/api/dataplane/v1alpha2/secret.proto b/proto/redpanda/api/dataplane/v1alpha2/secret.proto
@@ -129,7 +129,7 @@ message CreateSecretRequest {
     }
   }];
 
-  // The secret data.
+  // The secret data. Must be Base64-encoded.
   bytes secret_data = 4 [
     (google.api.field_behavior) = INPUT_ONLY,
     (google.api.field_behavior) = REQUIRED,
@@ -174,7 +174,7 @@ message UpdateSecretRequest {
     }
   }];
 
-  // The secret data.
+  // The secret data. Must be Base64-encoded.
   bytes secret_data = 4 [
     (google.api.field_behavior) = INPUT_ONLY,
     (google.api.field_behavior) = REQUIRED,
@@ -267,7 +267,7 @@ message CreateConnectSecretRequest {
     (google.api.field_behavior) = IMMUTABLE
   ];
 
-  // The secret data.
+  // The secret data. Must be Base64-encoded.
   bytes secret_data = 4 [
     (google.api.field_behavior) = INPUT_ONLY,
     (google.api.field_behavior) = REQUIRED,
@@ -360,7 +360,7 @@ message UpdateConnectSecretRequest {
     (google.api.field_behavior) = IMMUTABLE
   ];
 
-  // The secret data.
+  // The secret data. Must be Base64-encoded.
   bytes secret_data = 4 [
     (google.api.field_behavior) = INPUT_ONLY,
     (google.api.field_behavior) = REQUIRED,