From 7536155d0e269bb2ad6eb4677474c5954ef6922e Mon Sep 17 00:00:00 2001 From: vbotbuildovich <62446873+vbotbuildovich@users.noreply.github.com> Date: Tue, 14 Oct 2025 21:09:43 +0000 Subject: [PATCH 1/2] auto-docs: Update Cloud API spec --- cloud-controlplane/cloud-controlplane.yaml | 39 +++++++++++++++++++--- cloud-dataplane/cloud-dataplane.yaml | 12 +++---- 2 files changed, 39 insertions(+), 12 deletions(-) diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 23f156a..9b709de 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -2520,8 +2520,9 @@ components: ServerlessCluster: description: Resource describing a ServerlessCluster. properties: - console: - $ref: '#/components/schemas/ServerlessCluster.Console' + console_private_url: + readOnly: true + type: string console_url: readOnly: true type: string @@ -2540,6 +2541,8 @@ components: description: Unique name of the Serverless cluster. example: development-ServerlessCluster type: string + network: + $ref: '#/components/schemas/ServerlessCluster.NetworkingConfig' planned_deletion: $ref: '#/components/schemas/PlannedDeletion' private_link: @@ -2562,11 +2565,15 @@ components: type: string title: ServerlessCluster type: object - ServerlessCluster.Console: - type: object ServerlessCluster.DataplaneAPI: description: Cluster's Data Plane API properties. properties: + private_url: + description: |- + private_url is the private url of the dataplane api if private networking + is enabled for this cluster. + readOnly: true + type: string url: readOnly: true type: string @@ -2574,13 +2581,31 @@ components: ServerlessCluster.KafkaAPI: description: Cluster's Kafka API properties. properties: + private_seed_brokers: + items: + type: string + readOnly: true + title: Kafka API seed brokers (also known as bootstrap servers). Private addresses + type: array seed_brokers: - description: Kafka API seed brokers (also known as bootstrap servers). items: type: string readOnly: true + title: Kafka API seed brokers (also known as bootstrap servers). Implicitly public type: array type: object + ServerlessCluster.NetworkingConfig: + properties: + private: + $ref: '#/components/schemas/ServerlessCluster.NetworkingConfig.State' + public: + $ref: '#/components/schemas/ServerlessCluster.NetworkingConfig.State' + type: object + ServerlessCluster.NetworkingConfig.State: + enum: + - STATE_DISABLED + - STATE_ENABLED + type: string ServerlessCluster.PrivateLink: properties: id: @@ -2591,6 +2616,10 @@ components: ServerlessCluster.SchemaRegistryStatus: description: Cluster's Schema Registry properties. properties: + private_url: + readOnly: true + title: Private url for the schema registry + type: string url: readOnly: true type: string diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index f8c4f3f..d0cbbbe 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -212,7 +212,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -683,7 +683,7 @@ components: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { - "resource": "projects/1234", + "resource": "projects/123", "service": "pubsub.googleapis.com" } } @@ -2081,8 +2081,6 @@ components: description: The secret data. Must be Base64-encoded. format: byte type: string - required: - - secret_data type: object UpdateSecretResponse: description: UpdateSecretResponse is the response of UpdateSecret. @@ -3493,7 +3491,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3612,7 +3610,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -5616,7 +5614,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy transform + summary: Deploy Transform tags: - Wasm Transforms /v1/transforms/{name}: From 8e4c0d68f1a8e07e4a9b44d8a929bf7f9735cd67 Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 17 Oct 2025 22:43:51 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- cloud-controlplane/cloud-controlplane.yaml | 4 ++-- cloud-dataplane/cloud-dataplane.yaml | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 9b709de..5bd6bba 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -2570,7 +2570,7 @@ components: properties: private_url: description: |- - private_url is the private url of the dataplane api if private networking + The private URL of the data plane API, if private networking is enabled for this cluster. readOnly: true type: string @@ -2618,7 +2618,7 @@ components: properties: private_url: readOnly: true - title: Private url for the schema registry + title: Private URL for the schema registry type: string url: readOnly: true diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index d0cbbbe..7d75e27 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -212,7 +212,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -3491,7 +3491,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3610,7 +3610,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -5614,7 +5614,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy Transform + summary: Deploy transform tags: - Wasm Transforms /v1/transforms/{name}: