Skip to content

Commit 9b258d3

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
auto-docs: Update Cloud API spec
1 parent 31dcc1a commit 9b258d3

2 files changed

Lines changed: 59 additions & 23 deletions

File tree

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -100,20 +100,6 @@ components:
100100
$ref: '#/components/schemas/ACLResource'
101101
title: A filter to match ACLs for resources
102102
type: object
103-
AIGateway:
104-
description: Cluster's AI Gateway properties.
105-
properties:
106-
url:
107-
description: AI Gateway URL.
108-
example: https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co
109-
readOnly: true
110-
type: string
111-
v2_url:
112-
description: AI Gateway v2 URL.
113-
example: https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co
114-
readOnly: true
115-
type: string
116-
type: object
117103
AWS.Role:
118104
description: Role identifies AWS role.
119105
properties:
@@ -268,6 +254,15 @@ components:
268254
- arn
269255
title: Security Group
270256
type: object
257+
AdpApi:
258+
description: Cluster's ADP API properties.
259+
properties:
260+
url:
261+
description: ADP API URL.
262+
example: https://adp-api.cjb69h1c4vs42pca89s0.clusters.rdpa.co
263+
readOnly: true
264+
type: string
265+
type: object
271266
Anytime:
272267
type: object
273268
AuthenticationConfiguration:
@@ -465,8 +460,10 @@ components:
465460
Cluster:
466461
description: Resource describing a Cluster.
467462
properties:
463+
adp_api:
464+
$ref: '#/components/schemas/AdpApi'
468465
ai_gateway:
469-
$ref: '#/components/schemas/AIGateway'
466+
$ref: '#/components/schemas/Cluster.AIGateway'
470467
api_gateway_access:
471468
$ref: '#/components/schemas/NetworkAccessMode'
472469
aws_private_link:
@@ -587,6 +584,20 @@ components:
587584
type: array
588585
title: Cluster
589586
type: object
587+
Cluster.AIGateway:
588+
description: Cluster's AI Gateway properties.
589+
properties:
590+
url:
591+
description: AI Gateway URL.
592+
example: https://ai-gateway.cjb69h1c4vs42pca89s0.clusters.rdpa.co
593+
readOnly: true
594+
type: string
595+
v2_url:
596+
description: AI Gateway v2 URL.
597+
example: https://aigw.cjb69h1c4vs42pca89s0.clusters.rdpa.co
598+
readOnly: true
599+
type: string
600+
type: object
590601
Cluster.CloudStorage:
591602
properties:
592603
aws:
@@ -3457,6 +3468,8 @@ components:
34573468
ServerlessCluster:
34583469
description: Resource describing a ServerlessCluster.
34593470
properties:
3471+
ai_gateway:
3472+
$ref: '#/components/schemas/ServerlessCluster.AIGateway'
34603473
console_private_url:
34613474
readOnly: true
34623475
type: string
@@ -3511,6 +3524,16 @@ components:
35113524
type: string
35123525
title: ServerlessCluster
35133526
type: object
3527+
ServerlessCluster.AIGateway:
3528+
description: Cluster's AI Gateway properties.
3529+
properties:
3530+
v2_url:
3531+
description: AI Gateway v2 URL.
3532+
example: https://d1d9risv0c3i7qbbeoc0.aigw.adp.us-east-1.mpx.prd.cloud.redpanda.com
3533+
readOnly: true
3534+
type: string
3535+
readOnly: true
3536+
type: object
35143537
ServerlessCluster.DataplaneAPI:
35153538
description: Cluster's Data Plane API properties.
35163539
properties:
@@ -5243,7 +5266,8 @@ paths:
52435266
application/json:
52445267
example:
52455268
clusters:
5246-
- ai_gateway: null
5269+
- adp_api: null
5270+
ai_gateway: null
52475271
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
52485272
cloud_provider: CLOUD_PROVIDER_GCP
52495273
cloud_provider_tags: {}
@@ -5585,6 +5609,7 @@ paths:
55855609
application/json:
55865610
example:
55875611
cluster:
5612+
adp_api: null
55885613
ai_gateway: null
55895614
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
55905615
cloud_provider: CLOUD_PROVIDER_GCP
@@ -6114,6 +6139,7 @@ paths:
61146139
cluster_type: TYPE_DEDICATED
61156140
created_at: "2023-01-01T00:00:00Z"
61166141
customer_managed_resources: null
6142+
egress_spec: null
61176143
id: cjd533pc4vs8pjdkrrv0
61186144
name: my-network
61196145
region: us-west1
@@ -6257,6 +6283,7 @@ paths:
62576283
cluster_type: TYPE_DEDICATED
62586284
created_at: "2023-01-01T00:00:00Z"
62596285
customer_managed_resources: null
6286+
egress_spec: null
62606287
id: cjd533pc4vs8pjdkrrv0
62616288
name: my-network
62626289
region: us-west1
@@ -6391,6 +6418,7 @@ paths:
63916418
response:
63926419
'@type': type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse
63936420
cluster:
6421+
adp_api: null
63946422
ai_gateway: null
63956423
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
63966424
cloud_provider: CLOUD_PROVIDER_GCP
@@ -6469,6 +6497,7 @@ paths:
64696497
cluster_type: TYPE_DEDICATED
64706498
created_at: "2023-01-01T00:00:00Z"
64716499
customer_managed_resources: null
6500+
egress_spec: null
64726501
id: cjb6capc4vs0m91gh3kg
64736502
name: my-new-cluster
64746503
region: us-central1
@@ -6520,6 +6549,7 @@ paths:
65206549
response:
65216550
'@type': type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse
65226551
cluster:
6552+
adp_api: null
65236553
ai_gateway: null
65246554
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
65256555
cloud_provider: CLOUD_PROVIDER_GCP
@@ -7468,7 +7498,8 @@ paths:
74687498
example:
74697499
next_page_token: some-opaque-string
74707500
serverless_clusters:
7471-
- console_private_url: ""
7501+
- ai_gateway: null
7502+
console_private_url: ""
74727503
console_url: https://console-d1d9risv0c3i7qbbeoc0.any.us-east-1.mpx.prd.cloud.redpanda.com
74737504
created_at: "2023-01-01T00:00:00Z"
74747505
dataplane_api:
@@ -7623,6 +7654,7 @@ paths:
76237654
application/json:
76247655
example:
76257656
serverless_cluster:
7657+
ai_gateway: null
76267658
console_private_url: ""
76277659
console_url: https://console-d1d9risv0c3i7qbbeoc0.any.us-east-1.mpx.prd.cloud.redpanda.com
76287660
created_at: "2023-01-01T00:00:00Z"

cloud-dataplane/cloud-dataplane.yaml

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ components:
6565
- ACL_PATTERN_ANY: Wildcard to match any pattern
6666
- ACL_PATTERN_LITERAL: Match a literal string
6767
- ACL_PATTERN_PREFIXED: Match a prefix
68+
- ACL_PATTERN_PREFIX: Match a prefix
6869
- ACL_PATTERN_MATCH: Match serves as a catch-all for all the names of a topic
6970
the principal is authorized to access
7071
enum:
7172
- ACL_PATTERN_ANY
7273
- ACL_PATTERN_LITERAL
7374
- ACL_PATTERN_PREFIXED
75+
- ACL_PATTERN_PREFIX
7476
- ACL_PATTERN_MATCH
7577
title: The ACL pattern type
7678
type: string
@@ -1153,17 +1155,17 @@ components:
11531155
In this example, in proto `field` could take one of the following values:
11541156
11551157
* `full_name` for a violation in the `full_name` value
1156-
* `email_addresses[1].email` for a violation in the `email` field of the
1158+
* `email_addresses[0].email` for a violation in the `email` field of the
11571159
first `email_addresses` message
1158-
* `email_addresses[3].type[2]` for a violation in the second `type`
1160+
* `email_addresses[2].type[1]` for a violation in the second `type`
11591161
value in the third `email_addresses` message.
11601162
11611163
In JSON, the same values are represented as:
11621164
11631165
* `fullName` for a violation in the `fullName` value
1164-
* `emailAddresses[1].email` for a violation in the `email` field of the
1166+
* `emailAddresses[0].email` for a violation in the `email` field of the
11651167
first `emailAddresses` message
1166-
* `emailAddresses[3].type[2]` for a violation in the second `type`
1168+
* `emailAddresses[2].type[1]` for a violation in the second `type`
11671169
value in the third `emailAddresses` message.
11681170
type: string
11691171
localized_message:
@@ -2224,9 +2226,11 @@ components:
22242226
description: |-
22252227
- PATTERN_TYPE_LITERAL: Must match the filter exactly
22262228
- PATTERN_TYPE_PREFIX: Will match anything that starts with filter
2229+
- PATTERN_TYPE_PREFIXED: Will match anything that starts with filter
22272230
enum:
22282231
- PATTERN_TYPE_LITERAL
22292232
- PATTERN_TYPE_PREFIX
2233+
- PATTERN_TYPE_PREFIXED
22302234
title: The matching pattern type
22312235
type: string
22322236
PermissionType:
@@ -3254,7 +3258,7 @@ components:
32543258
- `redpanda.remote.allowgaps`
32553259
- `redpanda.virtual.cluster.id`
32563260
- `redpanda.leaders.preference`
3257-
- `redpanda.cloud_topic.enabled`
3261+
- `redpanda.storage.mode`
32583262
32593263
This list is a list of properties in addition to the default properties
32603264
that will be synced. See `exclude_default`.
@@ -7852,7 +7856,7 @@ paths:
78527856
schema:
78537857
$ref: '#/components/schemas/TransformMetadata'
78547858
description: Created
7855-
summary: Deploy transform
7859+
summary: Deploy Transform
78567860
tags:
78577861
- Wasm Transforms
78587862
/v1/transforms/{name}:

0 commit comments

Comments
 (0)