Skip to content

Commit 8ea7598

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
auto-docs: Update Cloud API spec
1 parent a6fca53 commit 8ea7598

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ components:
107107
type: string
108108
type: array
109109
connect_console:
110-
description: Whether Console is connected in Redpanda AWS Private Link Service.
110+
description: Whether Console is connected in Redpanda AWS Private Link Service. The default is true if not set.
111+
nullable: true
111112
type: boolean
112113
enabled:
113114
description: Whether Redpanda AWS Private Link Endpoint Service is enabled.
@@ -221,7 +222,8 @@ components:
221222
type: string
222223
type: array
223224
connect_console:
224-
description: Whether Console is connected in Redpanda Azure Private Link Service.
225+
description: Whether Console is connected in Redpanda Azure Private Link Service. The default is true if not set.
226+
nullable: true
225227
type: boolean
226228
enabled:
227229
description: Enabled controls if Azure Private Link Endpoint Service is enabled.
@@ -265,6 +267,8 @@ components:
265267
Cluster:
266268
description: Resource describing a Cluster.
267269
properties:
270+
api_gateway_access:
271+
$ref: '#/components/schemas/NetworkAccessMode'
268272
aws_private_link:
269273
$ref: '#/components/schemas/AWSPrivateLink'
270274
azure_private_link:
@@ -504,6 +508,8 @@ components:
504508
ClusterCreate:
505509
description: Resource describing a Create Cluster.
506510
properties:
511+
api_gateway_access:
512+
$ref: '#/components/schemas/NetworkAccessMode'
507513
aws_private_link:
508514
$ref: '#/components/schemas/AWSPrivateLinkSpec'
509515
azure_private_link:
@@ -646,6 +652,8 @@ components:
646652
ClusterUpdate:
647653
description: Resource describing an Update Cluster.
648654
properties:
655+
api_gateway_access:
656+
$ref: '#/components/schemas/NetworkAccessMode'
649657
aws_private_link:
650658
$ref: '#/components/schemas/AWSPrivateLinkSpec'
651659
azure_private_link:
@@ -1944,6 +1952,12 @@ components:
19441952
- STATE_DELETING
19451953
- STATE_FAILED
19461954
type: string
1955+
NetworkAccessMode:
1956+
description: Network access mode for an endpoint.
1957+
enum:
1958+
- NETWORK_ACCESS_MODE_PRIVATE
1959+
- NETWORK_ACCESS_MODE_PUBLIC
1960+
type: string
19471961
NetworkCreate:
19481962
description: Redpanda Cloud network properties.
19491963
properties:
@@ -3258,7 +3272,7 @@ components:
32583272
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
32593273
type: oauth2
32603274
info:
3261-
description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.'
3275+
description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups.
32623276
title: Redpanda Cloud Control Plane API
32633277
version: v1
32643278
openapi: 3.0.3
@@ -3316,7 +3330,8 @@ paths:
33163330
application/json:
33173331
example:
33183332
clusters:
3319-
- cloud_provider: CLOUD_PROVIDER_GCP
3333+
- api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
3334+
cloud_provider: CLOUD_PROVIDER_GCP
33203335
cloud_provider_tags: {}
33213336
cloud_storage: null
33223337
cluster_configuration: null
@@ -3500,6 +3515,8 @@ paths:
35003515
schema:
35013516
description: Resource describing an Update Cluster.
35023517
properties:
3518+
api_gateway_access:
3519+
$ref: '#/components/schemas/NetworkAccessMode'
35033520
aws_private_link:
35043521
$ref: '#/components/schemas/AWSPrivateLinkSpec'
35053522
azure_private_link:
@@ -3651,6 +3668,7 @@ paths:
36513668
application/json:
36523669
example:
36533670
cluster:
3671+
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
36543672
cloud_provider: CLOUD_PROVIDER_GCP
36553673
cloud_provider_tags: {}
36563674
cloud_storage: null
@@ -4049,6 +4067,7 @@ paths:
40494067
response:
40504068
'@type': type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse
40514069
cluster:
4070+
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
40524071
cloud_provider: CLOUD_PROVIDER_GCP
40534072
cloud_provider_tags: {}
40544073
cloud_storage: null
@@ -4174,6 +4193,7 @@ paths:
41744193
response:
41754194
'@type': type.googleapis.com/redpanda.api.controlplane.v1.CreateClusterResponse
41764195
cluster:
4196+
api_gateway_access: NETWORK_ACCESS_MODE_UNSPECIFIED
41774197
cloud_provider: CLOUD_PROVIDER_GCP
41784198
cloud_provider_tags: {}
41794199
cloud_storage: null
@@ -5690,7 +5710,7 @@ tags:
56905710
name: Resource Groups
56915711
- description: Manage [Redpanda Serverless](https://docs.redpanda.com/redpanda-cloud/get-started/cloud-overview/#redpanda-cloud-cluster-types) clusters. For detailed steps, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/).
56925712
name: Serverless Clusters
5693-
- description: Manage Redpanda Serverless Private Links.
5713+
- description: Manage Redpanda Serverless Private Links. For detailed steps and information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/).
56945714
name: Serverless Private Links
56955715
- description: See available Redpanda Serverless regions.
56965716
name: Serverless Regions

cloud-dataplane/cloud-dataplane.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ components:
212212
info:
213213
$ref: '#/components/schemas/ConnectCluster.Info'
214214
name:
215-
description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`.
215+
description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`.
216216
type: string
217217
plugins:
218218
items:
@@ -3491,7 +3491,7 @@ paths:
34913491
description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.'
34923492
operationId: SecretService_ListKafkaConnectSecrets
34933493
parameters:
3494-
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
3494+
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
34953495
in: path
34963496
name: cluster_name
34973497
required: true
@@ -3608,7 +3608,7 @@ paths:
36083608
description: Delete a Kafka Connect cluster secret.
36093609
operationId: SecretService_DeleteKafkaConnectSecret
36103610
parameters:
3611-
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
3611+
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
36123612
in: path
36133613
name: cluster_name
36143614
required: true
@@ -5610,7 +5610,7 @@ paths:
56105610
schema:
56115611
$ref: '#/components/schemas/TransformMetadata'
56125612
description: Created
5613-
summary: Deploy transform
5613+
summary: Deploy Transform
56145614
tags:
56155615
- Wasm Transforms
56165616
/v1/transforms/{name}:

0 commit comments

Comments
 (0)