Skip to content

Commit 1c13306

Browse files
vbotbuildovichkbatuigas
vbotbuildovich
and
kbatuigas
authored
auto-docs: Update Cloud API spec (#20)
* auto-docs: Update Cloud API spec * Apply suggestions from code review --------- Co-authored-by: Kat Batuigas <[email protected]>
1 parent c367e5b commit 1c13306

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

‎cloud-controlplane/cloud-controlplane.yaml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1999,6 +1999,9 @@ components:
19991999
- TYPE_DELETE_SERVERLESS_CLUSTER
20002000
- TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES
20012001
- TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES
2002+
- TYPE_CREATE_SERVERLESS_PRIVATE_LINK
2003+
- TYPE_UPDATE_SERVERLESS_PRIVATE_LINK
2004+
- TYPE_DELETE_SERVERLESS_PRIVATE_LINK
20022005
type: string
20032006
OperationMetadata:
20042007
description: Metadata of the long-running Operation. Contains in-progress information.
@@ -3961,6 +3964,9 @@ paths:
39613964
- TYPE_DELETE_SERVERLESS_CLUSTER
39623965
- TYPE_CREATE_CLUSTER_WITH_DEPENDENCIES
39633966
- TYPE_DELETE_CLUSTER_WITH_DEPENDENCIES
3967+
- TYPE_CREATE_SERVERLESS_PRIVATE_LINK
3968+
- TYPE_UPDATE_SERVERLESS_PRIVATE_LINK
3969+
- TYPE_DELETE_SERVERLESS_PRIVATE_LINK
39643970
type: string
39653971
type: array
39663972
- in: query
@@ -5684,7 +5690,8 @@ tags:
56845690
name: Resource Groups
56855691
- 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/).
56865692
name: Serverless Clusters
5687-
- name: ServerlessPrivateLinkService
5693+
- description: Manage Redpanda Serverless Private Links.
5694+
name: Serverless Private Links
56885695
- description: See available Redpanda Serverless regions.
56895696
name: Serverless Regions
56905697
- description: See information about the organization the current user belongs to.

‎cloud-dataplane/cloud-dataplane.yaml‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2227,7 +2227,6 @@ components:
22272227
info:
22282228
title: Redpanda Cloud Data Plane API
22292229
version: v1
2230-
description: 'Use the Data Plane API to manage topics, ACLs, and connectors within each cluster.'
22312230
openapi: 3.0.3
22322231
paths:
22332232
/v1/acls:
@@ -2891,7 +2890,7 @@ paths:
28912890
description: List connectors managed by the Kafka Connect service.
28922891
operationId: KafkaConnectService_ListConnectors
28932892
parameters:
2894-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
2893+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
28952894
in: path
28962895
name: cluster_name
28972896
required: true
@@ -2940,7 +2939,7 @@ paths:
29402939
description: Create a connector with the specified configuration.
29412940
operationId: KafkaConnectService_CreateConnector
29422941
parameters:
2943-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
2942+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
29442943
in: path
29452944
name: cluster_name
29462945
required: true
@@ -2986,7 +2985,7 @@ paths:
29862985
description: Delete a connector. This operation force stops all tasks and also deletes the connector configuration.
29872986
operationId: KafkaConnectService_DeleteConnector
29882987
parameters:
2989-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
2988+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
29902989
in: path
29912990
name: cluster_name
29922991
required: true
@@ -3029,7 +3028,7 @@ paths:
30293028
description: Get information about a connector in a specific cluster.
30303029
operationId: KafkaConnectService_GetConnector
30313030
parameters:
3032-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
3031+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
30333032
in: path
30343033
name: cluster_name
30353034
required: true
@@ -3074,7 +3073,7 @@ paths:
30743073
description: Get the configuration for the connector.
30753074
operationId: KafkaConnectService_GetConnectorConfig
30763075
parameters:
3077-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
3076+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
30783077
in: path
30793078
name: cluster_name
30803079
required: true
@@ -3112,7 +3111,7 @@ paths:
31123111
description: Update the configuration for an existing connector with the specified name, or create a new connector using the given configuration. Returns information about the connector after the change has been made.
31133112
operationId: KafkaConnectService_UpsertConnector
31143113
parameters:
3115-
- description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`.
3114+
- description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`.
31163115
in: path
31173116
name: cluster_name
31183117
required: true
@@ -4015,7 +4014,7 @@ paths:
40154014
description: An unexpected error response.
40164015
summary: Retrieve the schema for Redpanda Connect pipeline configurations
40174016
tags:
4018-
- Redpanda Connect Pipeline
4017+
- Redpanda Connect Pipelines
40194018
/v1/redpanda-connect/pipelines:
40204019
get:
40214020
description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.'
@@ -4071,7 +4070,7 @@ paths:
40714070
description: An unexpected error response.
40724071
summary: List Redpanda Connect pipelines
40734072
tags:
4074-
- Redpanda Connect Pipeline
4073+
- Redpanda Connect Pipelines
40754074
post:
40764075
description: Create a new Redpanda Connect pipeline.
40774076
operationId: PipelineService_CreatePipeline
@@ -4109,7 +4108,7 @@ paths:
41094108
description: An unexpected error response.
41104109
summary: Create Redpanda Connect pipeline
41114110
tags:
4112-
- Redpanda Connect Pipeline
4111+
- Redpanda Connect Pipelines
41134112
/v1/redpanda-connect/pipelines-by-secrets:
41144113
get:
41154114
description: Get Redpanda Connect pipelines by secrets.
@@ -4141,7 +4140,7 @@ paths:
41414140
description: An unexpected error response.
41424141
summary: Get Redpanda Connect pipelines by secrets
41434142
tags:
4144-
- Redpanda Connect Pipeline
4143+
- Redpanda Connect Pipelines
41454144
/v1/redpanda-connect/pipelines-for-secret:
41464145
get:
41474146
description: Get Redpanda Connect pipelines for a given secret.
@@ -4180,7 +4179,7 @@ paths:
41804179
description: An unexpected error response.
41814180
summary: Get Redpanda Connect pipelines for secret
41824181
tags:
4183-
- Redpanda Connect Pipeline
4182+
- Redpanda Connect Pipelines
41844183
/v1/redpanda-connect/pipelines/{id}:
41854184
delete:
41864185
description: Delete a Redpanda Connect pipeline.
@@ -4224,7 +4223,7 @@ paths:
42244223
description: An unexpected error response.
42254224
summary: Delete a Redpanda Connect pipeline
42264225
tags:
4227-
- Redpanda Connect Pipeline
4226+
- Redpanda Connect Pipelines
42284227
get:
42294228
description: Get a specific Redpanda Connect pipeline.
42304229
operationId: PipelineService_GetPipeline
@@ -4268,7 +4267,7 @@ paths:
42684267
description: An unexpected error response.
42694268
summary: Get Redpanda Connect pipeline
42704269
tags:
4271-
- Redpanda Connect Pipeline
4270+
- Redpanda Connect Pipelines
42724271
put:
42734272
description: Update the [configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) of a Redpanda Connect pipeline.
42744273
operationId: PipelineService_UpdatePipeline
@@ -4320,7 +4319,7 @@ paths:
43204319
description: An unexpected error response.
43214320
summary: Update a Redpanda Connect pipeline
43224321
tags:
4323-
- Redpanda Connect Pipeline
4322+
- Redpanda Connect Pipelines
43244323
/v1/redpanda-connect/pipelines/{id}/start:
43254324
put:
43264325
description: Start a stopped Redpanda Connect pipeline.
@@ -4365,7 +4364,7 @@ paths:
43654364
description: An unexpected error response.
43664365
summary: Start a Redpanda Connect pipeline
43674366
tags:
4368-
- Redpanda Connect Pipeline
4367+
- Redpanda Connect Pipelines
43694368
/v1/redpanda-connect/pipelines/{id}/stop:
43704369
put:
43714370
description: Stop a running Redpanda Connect pipeline.
@@ -4410,7 +4409,7 @@ paths:
44104409
description: An unexpected error response.
44114410
summary: Stops a Redpanda Connect pipeline
44124411
tags:
4413-
- Redpanda Connect Pipeline
4412+
- Redpanda Connect Pipelines
44144413
/v1/redpanda-connect/pipelines:lint-config:
44154414
post:
44164415
description: Validates a supplied Redpanda Connect pipeline YAML and returns a list of linting hints. If no problems are found, the list is empty.
@@ -4449,7 +4448,7 @@ paths:
44494448
description: An unexpected error response.
44504449
summary: Lint a Redpanda Connect pipeline configuration
44514450
tags:
4452-
- Redpanda Connect Pipeline
4451+
- Redpanda Connect Pipelines
44534452
/v1/roles:
44544453
get:
44554454
description: 'List roles. Optional: filter based on role name and principal.'
@@ -5585,7 +5584,7 @@ paths:
55855584
description: An unexpected error response.
55865585
summary: List transforms
55875586
tags:
5588-
- WASM Transforms
5587+
- Wasm Transforms
55895588
put:
55905589
description: Initiate deployment of a new Wasm transform. This endpoint uses multipart/form-data encoding. Following deployment, a brief period is required before the Wasm transform becomes operational. Monitor the partition statuses to check whether the transform is active. This usually takes around 3s, but no longer than 10s.
55915590
operationId: TransformService_DeployTransform
@@ -5613,7 +5612,7 @@ paths:
56135612
description: Created
56145613
summary: Deploy transform
56155614
tags:
5616-
- WASM Transforms
5615+
- Wasm Transforms
56175616
/v1/transforms/{name}:
56185617
delete:
56195618
description: Delete a Wasm transform with the requested name.
@@ -5660,7 +5659,7 @@ paths:
56605659
description: An unexpected error response.
56615660
summary: Delete transform
56625661
tags:
5663-
- WASM Transforms
5662+
- Wasm Transforms
56645663
get:
56655664
description: Get a specific Wasm transform.
56665665
operationId: TransformService_GetTransform
@@ -5719,7 +5718,7 @@ paths:
57195718
description: An unexpected error response.
57205719
summary: Get transform
57215720
tags:
5722-
- WASM Transforms
5721+
- Wasm Transforms
57235722
/v1/users:
57245723
get:
57255724
description: 'List users. Optional: filter based on username.'
@@ -6006,11 +6005,11 @@ tags:
60066005
- description: 'Manage Redpanda topics stored in object storage. See: [Mountable Topics](https://docs.redpanda.com/redpanda-cloud/manage/mountable-topics/)'
60076006
name: Cloud Storage
60086007
- description: Manage Wasm transforms in Redpanda.
6009-
name: WASM Transforms
6008+
name: Wasm Transforms
60106009
- description: Manage [connectors](https://docs.redpanda.com/redpanda-cloud/develop/managed-connectors/) and interact with the Kafka Connect API.
60116010
name: Kafka Connect
60126011
- description: Create and manage [Redpanda Connect](https://docs.redpanda.com/redpanda-cloud/develop/connect/about) pipelines and their configurations.
6013-
name: Redpanda Connect Pipeline
6012+
name: Redpanda Connect Pipelines
60146013
- description: Manage client throughput limits. See [Redpanda Client Throughput Limits](https://docs.redpanda.com/current/manage/cluster-maintenance/manage-throughput/#client-throughput-limits) for more information.
60156014
name: Quotas
60166015
- description: Manage [secrets](https://docs.redpanda.com/redpanda-cloud/security/secrets) for Redpanda Cloud.
@@ -6019,5 +6018,5 @@ tags:
60196018
name: Security
60206019
- description: Manage Redpanda topics.
60216020
name: Topics
6022-
- description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/doc/cloud-dataplane/group/endpoint-redpanda-users).
6021+
- description: Manage Redpanda users. For more information, see [Role-Based Access Control](https://docs.redpanda.com/redpanda-cloud/security/authorization/rbac/).
60236022
name: Redpanda Users

0 commit comments

Comments
 (0)