Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auto-docs: Update Cloud API spec #1020

Merged
merged 2 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 54 additions & 59 deletions modules/ROOT/attachments/cloud-controlplane-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2435,62 +2435,6 @@ components:
type: object
Unspecified:
type: object
UpdateClusterBody:
description: UpdateClusterRequest is the request of UpdateCluster.
properties:
cluster:
description: Resource describing an Update Cluster.
properties:
aws_private_link:
$ref: '#/components/schemas/AWSPrivateLinkSpec'
azure_private_link:
$ref: '#/components/schemas/AzurePrivateLinkSpec'
cloud_provider_tags:
additionalProperties:
type: string
description: |-
Tags that are placed on Cloud resources.
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
is a normal tag.
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: The value of a network tag will be ignored.
See the details on network tags at https://cloud.google.com/vpc/docs/add-remove-network-tags.
type: object
cluster_configuration:
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'
customer_managed_resources:
$ref: '#/components/schemas/CustomerManagedResourcesUpdate'
gcp_private_service_connect:
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
http_proxy:
$ref: '#/components/schemas/HTTPProxySpec'
kafka_api:
$ref: '#/components/schemas/KafkaAPISpec'
kafka_connect:
$ref: '#/components/schemas/KafkaConnect'
maintenance_window_config:
$ref: '#/components/schemas/MaintenanceWindowConfig'
name:
description: Unique name of the cluster.
example: development-cluster
type: string
read_replica_cluster_ids:
description: IDs of clusters which may create read-only topics from this cluster.
items:
type: string
type: array
schema_registry:
$ref: '#/components/schemas/SchemaRegistrySpec'
title: ClusterUpdate
type: object
update_mask:
type: string
required:
- cluster
- update_mask
type: object
UpdateClusterMetadata:
description: Resource describing an in-progress UpdateCluster Operation.
title: UpdateClusterMetadata
Expand Down Expand Up @@ -3172,9 +3116,60 @@ paths:
-----END CERTIFICATE-----
enabled: true
schema:
$ref: '#/components/schemas/UpdateClusterBody'
description: Resource describing an Update Cluster.
properties:
aws_private_link:
$ref: '#/components/schemas/AWSPrivateLinkSpec'
azure_private_link:
$ref: '#/components/schemas/AzurePrivateLinkSpec'
cloud_provider_tags:
additionalProperties:
type: string
description: |-
Tags that are placed on Cloud resources.
If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag
is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag
is a normal tag.
For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named
"network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: The value of a network tag will be ignored.
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
type: object
cluster_configuration:
$ref: '#/components/schemas/ClusterUpdate.ClusterConfiguration'
customer_managed_resources:
$ref: '#/components/schemas/CustomerManagedResourcesUpdate'
gcp_private_service_connect:
$ref: '#/components/schemas/GCPPrivateServiceConnectSpec'
http_proxy:
$ref: '#/components/schemas/HTTPProxySpec'
kafka_api:
$ref: '#/components/schemas/KafkaAPISpec'
kafka_connect:
$ref: '#/components/schemas/KafkaConnect'
maintenance_window_config:
$ref: '#/components/schemas/MaintenanceWindowConfig'
name:
description: Unique name of the cluster.
example: development-cluster
type: string
read_replica_cluster_ids:
description: IDs of clusters which may create read-only topics from this cluster.
items:
type: string
type: array
schema_registry:
$ref: '#/components/schemas/SchemaRegistrySpec'
required:
- cluster
title: ClusterUpdate
type: object
description: |-
ClusterUpdate

Resource describing an Update Cluster.
required: true
x-originalParamName: body
x-originalParamName: cluster
responses:
"202":
content:
Expand All @@ -3190,7 +3185,7 @@ paths:
state: STATE_IN_PROGRESS
type: TYPE_UPDATE_CLUSTER
schema:
$ref: '#/components/schemas/UpdateClusterOperation'
$ref: '#/components/schemas/ClusterUpdate'
description: Accepted
"404":
content:
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/attachments/cloud-dataplane-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1767,7 +1767,7 @@ components:
description: RedpandaCloud
flows:
implicit:
authorizationUrl: https://prod-cloudv2.us.auth0.com/oauth/authorize
authorizationUrl: https://auth.prd.cloud.redpanda.com/oauth/authorize
scopes: {}
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
type: oauth2
Expand Down Expand Up @@ -4576,7 +4576,7 @@ paths:
content:
multipart/form-data:
schema:
example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
properties:
metadata:
$ref: '#/components/schemas/DeployTransformRequest'
Expand Down