auto-docs: Update Cloud API spec

Author: vbotbuildovich

cloud-controlplane/cloud-controlplane.yaml

@@ -100,20 +100,6 @@ components:
           $ref: '#/components/schemas/ACLResource'
       title: A filter to match ACLs for resources
       type: object
-    AIGateway:
-      description: Cluster's AI Gateway properties.
-      properties:
-        url:
-          description: AI Gateway URL.
-          example: https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co
-          readOnly: true
-          type: string
-        v2_url:
-          description: AI Gateway v2 URL.
-          example: https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co
-          readOnly: true
-          type: string
-      type: object
     AWS.Role:
       description: Role identifies AWS role.
       properties:
@@ -466,7 +452,7 @@ components:
       description: Resource describing a Cluster.
       properties:
         ai_gateway:
-          $ref: '#/components/schemas/AIGateway'
+          $ref: '#/components/schemas/Cluster.AIGateway'
         api_gateway_access:
           $ref: '#/components/schemas/NetworkAccessMode'
         aws_private_link:
@@ -587,6 +573,20 @@ components:
           type: array
       title: Cluster
       type: object
+    Cluster.AIGateway:
+      description: Cluster's AI Gateway properties.
+      properties:
+        url:
+          description: AI Gateway URL.
+          example: https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co
+          readOnly: true
+          type: string
+        v2_url:
+          description: AI Gateway v2 URL.
+          example: https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co
+          readOnly: true
+          type: string
+      type: object
     Cluster.CloudStorage:
       properties:
         aws:
@@ -3457,6 +3457,8 @@ components:
     ServerlessCluster:
       description: Resource describing a ServerlessCluster.
       properties:
+        ai_gateway:
+          $ref: '#/components/schemas/ServerlessCluster.AIGateway'
         console_private_url:
           readOnly: true
           type: string
@@ -3511,6 +3513,16 @@ components:
           type: string
       title: ServerlessCluster
       type: object
+    ServerlessCluster.AIGateway:
+      description: Cluster's AI Gateway properties.
+      properties:
+        v2_url:
+          description: AI Gateway v2 URL.
+          example: https://d1d9risv0c3i7qbbeoc0.aigw.adp.us-east-1.mpx.prd.cloud.redpanda.com
+          readOnly: true
+          type: string
+      readOnly: true
+      type: object
     ServerlessCluster.DataplaneAPI:
       description: Cluster's Data Plane API properties.
       properties:
@@ -7468,7 +7480,8 @@ paths:
               example:
                 next_page_token: some-opaque-string
                 serverless_clusters:
-                  - console_private_url: ""
+                  - ai_gateway: null
+                    console_private_url: ""
                     console_url: https://console-d1d9risv0c3i7qbbeoc0.any.us-east-1.mpx.prd.cloud.redpanda.com
                     created_at: "2023-01-01T00:00:00Z"
                     dataplane_api:
@@ -7623,6 +7636,7 @@ paths:
             application/json:
               example:
                 serverless_cluster:
+                  ai_gateway: null
                   console_private_url: ""
                   console_url: https://console-d1d9risv0c3i7qbbeoc0.any.us-east-1.mpx.prd.cloud.redpanda.com
                   created_at: "2023-01-01T00:00:00Z"

cloud-dataplane/cloud-dataplane.yaml

@@ -65,12 +65,14 @@ components:
         - ACL_PATTERN_ANY: Wildcard to match any pattern
          - ACL_PATTERN_LITERAL: Match a literal string
          - ACL_PATTERN_PREFIXED: Match a prefix
+         - ACL_PATTERN_PREFIX: Match a prefix
          - ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic
         the principal is authorized to access
       enum:
         - ACL_PATTERN_ANY
         - ACL_PATTERN_LITERAL
         - ACL_PATTERN_PREFIXED
+        - ACL_PATTERN_PREFIX
         - ACL_PATTERN_MATCH
       title: The ACL pattern type
       type: string
@@ -1153,17 +1155,17 @@ components:
             In this example, in proto `field` could take one of the following values:
 
             * `full_name` for a violation in the `full_name` value
-            * `email_addresses[1].email` for a violation in the `email` field of the
+            * `email_addresses[0].email` for a violation in the `email` field of the
               first `email_addresses` message
-            * `email_addresses[3].type[2]` for a violation in the second `type`
+            * `email_addresses[2].type[1]` for a violation in the second `type`
               value in the third `email_addresses` message.
 
             In JSON, the same values are represented as:
 
             * `fullName` for a violation in the `fullName` value
-            * `emailAddresses[1].email` for a violation in the `email` field of the
+            * `emailAddresses[0].email` for a violation in the `email` field of the
               first `emailAddresses` message
-            * `emailAddresses[3].type[2]` for a violation in the second `type`
+            * `emailAddresses[2].type[1]` for a violation in the second `type`
               value in the third `emailAddresses` message.
           type: string
         localized_message:
@@ -2224,9 +2226,11 @@ components:
       description: |-
         - PATTERN_TYPE_LITERAL: Must match the filter exactly
          - PATTERN_TYPE_PREFIX: Will match anything that starts with filter
+         - PATTERN_TYPE_PREFIXED: Will match anything that starts with filter
       enum:
         - PATTERN_TYPE_LITERAL
         - PATTERN_TYPE_PREFIX
+        - PATTERN_TYPE_PREFIXED
       title: The matching pattern type
       type: string
     PermissionType:
@@ -3254,7 +3258,7 @@ components:
             - `redpanda.remote.allowgaps`
             - `redpanda.virtual.cluster.id`
             - `redpanda.leaders.preference`
-            - `redpanda.cloud_topic.enabled`
+            - `redpanda.storage.mode`
 
             This list is a list of properties in addition to the default properties
             that will be synced.  See `exclude_default`.
@@ -7834,7 +7838,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'
@@ -7852,7 +7856,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/TransformMetadata'
           description: Created
-      summary: Deploy transform
+      summary: Deploy Transform
       tags:
         - Wasm Transforms
   /v1/transforms/{name}: