Skip to content

Commit 03da0d1

Browse files
auto-docs: Update Cloud API spec (#1020)
Co-authored-by: Kat Batuigas <[email protected]>
1 parent 621111f commit 03da0d1

File tree

2 files changed

+56
-61
lines changed

2 files changed

+56
-61
lines changed

modules/ROOT/attachments/cloud-controlplane-api.yaml

+54-59
Original file line numberDiff line numberDiff line change
@@ -2435,62 +2435,6 @@ components:
24352435
type: object
24362436
Unspecified:
24372437
type: object
2438-
UpdateClusterBody:
2439-
description: UpdateClusterRequest is the request of UpdateCluster.
2440-
properties:
2441-
cluster:
2442-
description: Resource describing an Update Cluster.
2443-
properties:
2444-
aws_private_link:
2445-
$ref: '#/components/schemas/AWSPrivateLinkSpec'
2446-
azure_private_link:
2447-
$ref: '#/components/schemas/AzurePrivateLinkSpec'
2448-
cloud_provider_tags:
2449-
additionalProperties:
2450-
type: string
2451-
description: |-
2452-
Tags that are placed on Cloud resources.
2453-
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
2454-
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
2455-
is a normal tag.
2456-
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
2457-
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
2458-
Note: The value of a network tag will be ignored.
2459-
See the details on network tags at https://cloud.google.com/vpc/docs/add-remove-network-tags.
2460-
type: object
2461-
cluster_configuration:
2462-
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'
2463-
customer_managed_resources:
2464-
$ref: '#/components/schemas/CustomerManagedResourcesUpdate'
2465-
gcp_private_service_connect:
2466-
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
2467-
http_proxy:
2468-
$ref: '#/components/schemas/HTTPProxySpec'
2469-
kafka_api:
2470-
$ref: '#/components/schemas/KafkaAPISpec'
2471-
kafka_connect:
2472-
$ref: '#/components/schemas/KafkaConnect'
2473-
maintenance_window_config:
2474-
$ref: '#/components/schemas/MaintenanceWindowConfig'
2475-
name:
2476-
description: Unique name of the cluster.
2477-
example: development-cluster
2478-
type: string
2479-
read_replica_cluster_ids:
2480-
description: IDs of clusters which may create read-only topics from this cluster.
2481-
items:
2482-
type: string
2483-
type: array
2484-
schema_registry:
2485-
$ref: '#/components/schemas/SchemaRegistrySpec'
2486-
title: ClusterUpdate
2487-
type: object
2488-
update_mask:
2489-
type: string
2490-
required:
2491-
- cluster
2492-
- update_mask
2493-
type: object
24942438
UpdateClusterMetadata:
24952439
description: Resource describing an in-progress UpdateCluster Operation.
24962440
title: UpdateClusterMetadata
@@ -3172,9 +3116,60 @@ paths:
31723116
-----END CERTIFICATE-----
31733117
enabled: true
31743118
schema:
3175-
$ref: '#/components/schemas/UpdateClusterBody'
3119+
description: Resource describing an Update Cluster.
3120+
properties:
3121+
aws_private_link:
3122+
$ref: '#/components/schemas/AWSPrivateLinkSpec'
3123+
azure_private_link:
3124+
$ref: '#/components/schemas/AzurePrivateLinkSpec'
3125+
cloud_provider_tags:
3126+
additionalProperties:
3127+
type: string
3128+
description: |-
3129+
Tags that are placed on Cloud resources.
3130+
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
3131+
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
3132+
is a normal tag.
3133+
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
3134+
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
3135+
Note: The value of a network tag will be ignored.
3136+
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
3137+
type: object
3138+
cluster_configuration:
3139+
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'
3140+
customer_managed_resources:
3141+
$ref: '#/components/schemas/CustomerManagedResourcesUpdate'
3142+
gcp_private_service_connect:
3143+
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
3144+
http_proxy:
3145+
$ref: '#/components/schemas/HTTPProxySpec'
3146+
kafka_api:
3147+
$ref: '#/components/schemas/KafkaAPISpec'
3148+
kafka_connect:
3149+
$ref: '#/components/schemas/KafkaConnect'
3150+
maintenance_window_config:
3151+
$ref: '#/components/schemas/MaintenanceWindowConfig'
3152+
name:
3153+
description: Unique name of the cluster.
3154+
example: development-cluster
3155+
type: string
3156+
read_replica_cluster_ids:
3157+
description: IDs of clusters which may create read-only topics from this cluster.
3158+
items:
3159+
type: string
3160+
type: array
3161+
schema_registry:
3162+
$ref: '#/components/schemas/SchemaRegistrySpec'
3163+
required:
3164+
- cluster
3165+
title: ClusterUpdate
3166+
type: object
3167+
description: |-
3168+
ClusterUpdate
3169+
3170+
Resource describing an Update Cluster.
31763171
required: true
3177-
x-originalParamName: body
3172+
x-originalParamName: cluster
31783173
responses:
31793174
"202":
31803175
content:
@@ -3190,7 +3185,7 @@ paths:
31903185
state: STATE_IN_PROGRESS
31913186
type: TYPE_UPDATE_CLUSTER
31923187
schema:
3193-
$ref: '#/components/schemas/UpdateClusterOperation'
3188+
$ref: '#/components/schemas/ClusterUpdate'
31943189
description: Accepted
31953190
"404":
31963191
content:

modules/ROOT/attachments/cloud-dataplane-api.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1767,7 +1767,7 @@ components:
17671767
description: RedpandaCloud
17681768
flows:
17691769
implicit:
1770-
authorizationUrl: https://prod-cloudv2.us.auth0.com/oauth/authorize
1770+
authorizationUrl: https://auth.prd.cloud.redpanda.com/oauth/authorize
17711771
scopes: {}
17721772
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
17731773
type: oauth2
@@ -4576,7 +4576,7 @@ paths:
45764576
content:
45774577
multipart/form-data:
45784578
schema:
4579-
example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
4579+
example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
45804580
properties:
45814581
metadata:
45824582
$ref: '#/components/schemas/DeployTransformRequest'

0 commit comments

Comments
 (0)