auto-docs: Update Cloud API spec

Author: vbotbuildovich

cloud-controlplane/cloud-controlplane.yaml

@@ -1693,6 +1693,9 @@ components:
         name_contains:
           description: Name of cluster. Partial match.
           type: string
+        private_link_id:
+          title: Private link ID of Serverless cluster
+          type: string
         resource_group_id:
           description: Resource group ID of Serverless cluster.
           type: string
@@ -2181,20 +2184,6 @@ components:
           title: status is the status of the Azure PE
           type: string
       type: object
-    PrivateLink.State:
-      description: |2-
-         - STATE_DISABLED: Private link is being created.
-         - STATE_LINKING: Private link is being created.
-         - STATE_READY: Private link is ready to use.
-         - STATE_UNLINKING: Private link is being deleted.
-         - STATE_FAILED: Private link is in an error state.
-      enum:
-        - STATE_DISABLED
-        - STATE_LINKING
-        - STATE_READY
-        - STATE_UNLINKING
-        - STATE_FAILED
-      type: string
     PrivateLinkAuthMode:
       description: |-
         Private link authentication mode.
@@ -2541,12 +2530,14 @@ components:
           description: Unique name of the Serverless cluster.
           example: development-ServerlessCluster
           type: string
-        network:
-          $ref: '#/components/schemas/ServerlessCluster.NetworkingConfig'
+        networking_config:
+          $ref: '#/components/schemas/ServerlessNetworkingConfig'
         planned_deletion:
           $ref: '#/components/schemas/PlannedDeletion'
-        private_link:
-          $ref: '#/components/schemas/ServerlessCluster.PrivateLink'
+        private_link_id:
+          nullable: true
+          readOnly: true
+          type: string
         resource_group_id:
           description: Resource group ID of the cluster.
           example: a0b40af9-0250-48ca-9417-783ed127ce42
@@ -2570,7 +2561,7 @@ components:
       properties:
         private_url:
           description: |-
-            The private URL of the data plane API, if private networking
+            private_url is the private url of the dataplane api if private networking
             is enabled for this cluster.
           readOnly: true
           type: string
@@ -2594,31 +2585,12 @@ components:
           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:
-          type: string
-        state:
-          $ref: '#/components/schemas/PrivateLink.State'
-      type: object
     ServerlessCluster.SchemaRegistryStatus:
       description: Cluster's Schema Registry properties.
       properties:
         private_url:
           readOnly: true
-          title: Private URL for the schema registry
+          title: Private url for the schema registry
           type: string
         url:
           readOnly: true
@@ -2663,6 +2635,28 @@ components:
         - serverless_region
       title: ServerlessClusterCreate
       type: object
+    ServerlessClusterUpdate:
+      description: Resource describing an Update Serverless Cluster.
+      properties:
+        id:
+          description: ID of the vcluster.
+          type: string
+      required:
+        - id
+      title: ServerlessClusterUpdate
+      type: object
+    ServerlessNetworkingConfig:
+      properties:
+        private:
+          $ref: '#/components/schemas/ServerlessNetworkingConfig.State'
+        public:
+          $ref: '#/components/schemas/ServerlessNetworkingConfig.State'
+      type: object
+    ServerlessNetworkingConfig.State:
+      enum:
+        - STATE_DISABLED
+        - STATE_ENABLED
+      type: string
     ServerlessRegion:
       description: Resource describing a ServerlessRegion.
       properties:
@@ -2854,6 +2848,7 @@ components:
     UpdateClusterType:
       enum:
         - UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
+        - UPDATE_CLUSTER_TYPE_SCALING
       type: string
     UpdateOrganizationResponse:
       properties:
@@ -2880,6 +2875,15 @@ components:
           $ref: '#/components/schemas/ResourceGroup'
       title: UpdateResourceGroupResponse is the response of UpdateResourceGroup
       type: object
+    UpdateServerlessClusterBody:
+      description: UpdateServerlessClusterRequest is the request of UpdateServerlessCluster.
+      type: object
+    UpdateServerlessClusterOperation:
+      description: UpdateServerlessClusterOperation is the response of the update cluster rpc.
+      properties:
+        operation:
+          $ref: '#/components/schemas/v1.Operation'
+      type: object
     UpdateServiceAccountBody:
       properties:
         service_account:
@@ -4914,6 +4918,11 @@ paths:
           name: filter.serverless_region
           schema:
             type: string
+        - description: Private link ID of Serverless cluster
+          in: query
+          name: filter.private_link_id
+          schema:
+            type: string
         - description: Limit the paginated response to a number of items.
           in: query
           name: page_size
@@ -5073,6 +5082,51 @@ paths:
       summary: Get Serverless cluster
       tags:
         - Serverless Clusters
+    patch:
+      description: Update a Redpanda serverless cluster.
+      operationId: ServerlessClusterService_UpdateServerlessCluster
+      parameters:
+        - description: ID of the virtual cluster.
+          in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateServerlessClusterBody'
+        required: true
+        x-originalParamName: body
+      responses:
+        "202":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ServerlessClusterUpdate'
+          description: Accepted
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/rpc.Status'
+          description: Not Found
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/rpc.Status'
+          description: Internal Server Error. Please reach out to support.
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/rpc.Status'
+          description: An unexpected error response.
+      summary: Update serverless cluster
+      tags:
+        - Serverless Clusters
   /v1/serverless/region:
     get:
       description: Get Redpanda Serverless region.

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:
@@ -1396,6 +1396,8 @@ components:
           type: string
         resources:
           $ref: '#/components/schemas/Resources'
+        service_account:
+          $ref: '#/components/schemas/ServiceAccount'
         state:
           $ref: '#/components/schemas/Pipeline.State'
         status:
@@ -1455,6 +1457,8 @@ components:
           type: string
         resources:
           $ref: '#/components/schemas/Resources'
+        service_account:
+          $ref: '#/components/schemas/ServiceAccount'
         tags:
           additionalProperties:
             type: string
@@ -1477,6 +1481,8 @@ components:
           type: string
         resources:
           $ref: '#/components/schemas/Resources'
+        service_account:
+          $ref: '#/components/schemas/ServiceAccount'
         tags:
           additionalProperties:
             type: string
@@ -1813,6 +1819,13 @@ components:
           title: Secret scopes
           type: array
       type: object
+    ServiceAccount:
+      properties:
+        client_id:
+          type: string
+        client_secret:
+          type: string
+      type: object
     SetConfiguration:
       properties:
         name:
@@ -3491,7 +3504,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 +3623,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
@@ -5596,7 +5609,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'
@@ -5614,7 +5627,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/TransformMetadata'
           description: Created
-      summary: Deploy transform
+      summary: Deploy Transform
       tags:
         - Wasm Transforms
   /v1/transforms/{name}: