Skip to content

Commit eff7f15

Browse files
vbotbuildovichgithub-actions[bot]
authored andcommitted
auto-docs: Update Cloud API spec
1 parent 0e58fc4 commit eff7f15

File tree

3 files changed

+2081
-124
lines changed

3 files changed

+2081
-124
lines changed

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 65 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -315,12 +315,6 @@ components:
315315
id:
316316
description: ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.
317317
type: string
318-
internet_gateways:
319-
description: InternetGateway information of the cluster.
320-
items:
321-
type: string
322-
readOnly: true
323-
type: array
324318
kafka_api:
325319
$ref: '#/components/schemas/Cluster.KafkaAPI'
326320
kafka_connect:
@@ -331,6 +325,12 @@ components:
331325
description: Unique name of the cluster.
332326
example: development-cluster
333327
type: string
328+
nat_gateways:
329+
description: NAT gateway information for the cluster.
330+
items:
331+
type: string
332+
readOnly: true
333+
type: array
334334
network_id:
335335
description: Network ID where cluster is placed.
336336
example: cjcuq79c4vs94fcufc2g
@@ -2096,13 +2096,20 @@ components:
20962096
id:
20972097
title: internal id of the organization
20982098
type: string
2099+
mfa_enforced:
2100+
type: boolean
20992101
name:
21002102
title: display name of the organization
21012103
type: string
21022104
welcome_cluster_id:
21032105
nullable: true
21042106
type: string
21052107
type: object
2108+
OrganizationUpdate:
2109+
properties:
2110+
mfa_enforced:
2111+
type: boolean
2112+
type: object
21062113
Placement:
21072114
description: Information about creation of new serverless clusters on the serverless region.
21082115
properties:
@@ -2791,6 +2798,11 @@ components:
27912798
enum:
27922799
- UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
27932800
type: string
2801+
UpdateOrganizationResponse:
2802+
properties:
2803+
organization:
2804+
$ref: '#/components/schemas/Organization'
2805+
type: object
27942806
UpdateResourceGroupBody:
27952807
properties:
27962808
resource_group:
@@ -3232,7 +3244,7 @@ components:
32323244
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
32333245
type: oauth2
32343246
info:
3235-
description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.'
3247+
description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups.
32363248
title: Redpanda Cloud Control Plane API
32373249
version: v1
32383250
openapi: 3.0.3
@@ -3309,7 +3321,6 @@ paths:
33093321
sasl: null
33103322
url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092
33113323
id: cjd3r21c4vs870t0ku30
3312-
internet_gateways: []
33133324
kafka_api:
33143325
all_seed_brokers: null
33153326
mtls: null
@@ -3319,6 +3330,7 @@ paths:
33193330
kafka_connect: null
33203331
maintenance_window_config: null
33213332
name: my-new-cluster
3333+
nat_gateways: []
33223334
network_id: cjb69k1c4vs45df9bee0
33233335
prometheus:
33243336
url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
@@ -3360,7 +3372,7 @@ paths:
33603372
tags:
33613373
- Clusters
33623374
post:
3363-
description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster).
3375+
description: Create a Redpanda cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster).
33643376
operationId: ClusterService_CreateCluster
33653377
requestBody:
33663378
content:
@@ -3568,7 +3580,7 @@ paths:
35683580
- Clusters
35693581
/v1/clusters/{id}:
35703582
delete:
3571-
description: Delete a Redpanda Cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
3583+
description: Delete a Redpanda Cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`.
35723584
operationId: ClusterService_DeleteCluster
35733585
parameters:
35743586
- in: path
@@ -3644,7 +3656,6 @@ paths:
36443656
sasl: null
36453657
url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092
36463658
id: cjd3r21c4vs870t0ku30
3647-
internet_gateways: []
36483659
kafka_api:
36493660
all_seed_brokers: null
36503661
mtls: null
@@ -3654,6 +3665,7 @@ paths:
36543665
kafka_connect: null
36553666
maintenance_window_config: null
36563667
name: my-new-cluster
3668+
nat_gateways: []
36573669
network_id: cjb69k1c4vs45df9bee0
36583670
prometheus:
36593671
url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
@@ -3701,7 +3713,7 @@ paths:
37013713
- Clusters
37023714
/v1/networks:
37033715
get:
3704-
description: List Redpanda Networks.
3716+
description: List Redpanda networks.
37053717
operationId: NetworkService_ListNetworks
37063718
parameters:
37073719
- description: Resource group ID.
@@ -3773,7 +3785,7 @@ paths:
37733785
tags:
37743786
- Networks
37753787
post:
3776-
description: Create a Redpanda network. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
3788+
description: Create a Redpanda network. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`.
37773789
operationId: NetworkService_CreateNetwork
37783790
requestBody:
37793791
content:
@@ -4039,7 +4051,6 @@ paths:
40394051
sasl: null
40404052
url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092
40414053
id: cjb69h1c4vs42pca89s0
4042-
internet_gateways: []
40434054
kafka_api:
40444055
all_seed_brokers: null
40454056
mtls: null
@@ -4049,6 +4060,7 @@ paths:
40494060
kafka_connect: null
40504061
maintenance_window_config: null
40514062
name: my-new-cluster
4063+
nat_gateways: []
40524064
network_id: cjb69k1c4vs45df9bee0
40534065
prometheus:
40544066
url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
@@ -4164,7 +4176,6 @@ paths:
41644176
sasl: null
41654177
url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092
41664178
id: cjb69h1c4vs42pca89s0
4167-
internet_gateways: []
41684179
kafka_api:
41694180
all_seed_brokers: null
41704181
mtls: null
@@ -4174,6 +4185,7 @@ paths:
41744185
kafka_connect: null
41754186
maintenance_window_config: null
41764187
name: my-new-cluster
4188+
nat_gateways: []
41774189
network_id: cjb69k1c4vs45df9bee0
41784190
prometheus:
41794191
url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
@@ -4263,7 +4275,7 @@ paths:
42634275
- Organization
42644276
/v1/organizations/current:
42654277
get:
4266-
description: Get current organizarion information
4278+
description: Get information about the current organization.
42674279
operationId: OrganizationService_GetCurrentOrganization
42684280
responses:
42694281
"200":
@@ -4287,9 +4299,41 @@ paths:
42874299
summary: Get current organization
42884300
tags:
42894301
- Organization
4302+
patch:
4303+
description: Update properties of the current organization.
4304+
operationId: OrganizationService_UpdateOrganization
4305+
requestBody:
4306+
content:
4307+
application/json:
4308+
schema:
4309+
$ref: '#/components/schemas/OrganizationUpdate'
4310+
required: true
4311+
x-originalParamName: organization
4312+
responses:
4313+
"200":
4314+
content:
4315+
application/json:
4316+
schema:
4317+
$ref: '#/components/schemas/UpdateOrganizationResponse'
4318+
description: OK
4319+
"500":
4320+
content:
4321+
application/json:
4322+
schema:
4323+
$ref: '#/components/schemas/rpc.Status'
4324+
description: Internal Server Error. Please reach out to support.
4325+
default:
4326+
content:
4327+
application/json:
4328+
schema:
4329+
$ref: '#/components/schemas/rpc.Status'
4330+
description: An unexpected error response.
4331+
summary: Update organization
4332+
tags:
4333+
- Organization
42904334
/v1/regions/{cloud_provider}:
42914335
get:
4292-
description: List available regions on the different cloud providers
4336+
description: List available regions on the different cloud providers.
42934337
operationId: RegionService_ListRegions
42944338
parameters:
42954339
- in: path
@@ -4437,7 +4481,7 @@ paths:
44374481
tags:
44384482
- Resource Groups
44394483
post:
4440-
description: Create a Redpanda Resource Group.
4484+
description: Create a Redpanda resource group.
44414485
operationId: ResourceGroupService_CreateResourceGroup
44424486
requestBody:
44434487
content:
@@ -4838,7 +4882,7 @@ paths:
48384882
tags:
48394883
- Serverless Clusters
48404884
post:
4841-
description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
4885+
description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
48424886
operationId: ServerlessClusterService_CreateServerlessCluster
48434887
requestBody:
48444888
content:
@@ -4884,7 +4928,7 @@ paths:
48844928
- Serverless Clusters
48854929
/v1/serverless/clusters/{id}:
48864930
delete:
4887-
description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
4931+
description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
48884932
operationId: ServerlessClusterService_DeleteServerlessCluster
48894933
parameters:
48904934
- description: ID of Serverless cluster.
@@ -5617,7 +5661,7 @@ servers:
56175661
- description: Control Plane API
56185662
url: https://api.redpanda.com
56195663
tags:
5620-
- description: Check the state of long-running operations. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information.
5664+
- description: Check the state of long-running operations.
56215665
name: Operations
56225666
- description: Manage Redpanda Cloud clusters. For detailed steps and information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/).
56235667
name: Clusters

0 commit comments

Comments
 (0)