Skip to content

auto-docs: Update Cloud API spec #1085

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

Merged
merged 2 commits into from
Apr 30, 2025
Merged
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
133 changes: 82 additions & 51 deletions modules/ROOT/attachments/cloud-controlplane-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ components:
- arn
title: Role
type: object
AWS.SecurityGroup:
description: Security Group identifies AWS security group.
AWSInstanceProfile:
description: AWS instance profile.
properties:
arn:
description: AWS security group ARN.
description: AWS instance profile ARN.
type: string
required:
- arn
title: Security Group
title: Instance Profile
type: object
AWSPrivateLink:
properties:
Expand Down Expand Up @@ -117,6 +117,16 @@ components:
schema_registry_auth_mode:
$ref: '#/components/schemas/PrivateLinkAuthMode'
type: object
AWSSecurityGroup:
description: Security Group identifies AWS security group.
properties:
arn:
description: AWS security group ARN.
type: string
required:
- arn
title: Security Group
type: object
Anytime:
type: object
AzurePrivateLink:
Expand Down Expand Up @@ -323,7 +333,7 @@ components:
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.
See the official [GCP VPC](https://cloud.google.com/vpc/docs/add-remove-network-tags) for more details on network tags.
type: object
cloud_storage:
$ref: '#/components/schemas/CloudStorage'
Expand Down Expand Up @@ -450,8 +460,8 @@ components:
Cluster.SchemaRegistryStatus:
description: Cluster's Schema Registry properties.
properties:
all_seed_brokers:
$ref: '#/components/schemas/SeedBrokers'
all_urls:
$ref: '#/components/schemas/Endpoints'
mtls:
$ref: '#/components/schemas/MTLSSpec'
sasl:
Expand Down Expand Up @@ -499,7 +509,7 @@ components:
For example, if the key of a tag is "gcp.network-tag.network-tag-foo",
the GCP network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes.
Note: If a tag is GCP network tag, its value will be ignored.
See the details on network tags at https://cloud.google.com/vpc/docs/add-remove-network-tags.
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/ClusterCreate.ClusterConfiguration'
Expand Down Expand Up @@ -592,7 +602,7 @@ components:
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.
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'
Expand Down Expand Up @@ -868,10 +878,21 @@ components:
type: object
CustomerManagedResourcesUpdate:
properties:
aws:
$ref: '#/components/schemas/CustomerManagedResourcesUpdate.AWS'
gcp:
$ref: '#/components/schemas/CustomerManagedResourcesUpdate.GCP'
title: The cloud resources created by user that can be updated
type: object
CustomerManagedResourcesUpdate.AWS:
description: AWS resources managed by user.
properties:
redpanda_connect_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
redpanda_connect_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
title: AWS Customer-Managed Resoures
type: object
CustomerManagedResourcesUpdate.GCP:
description: GCP resources managed by user.
properties:
Expand Down Expand Up @@ -972,6 +993,22 @@ components:
type: object
DeleteUserResponse:
type: object
Endpoints:
description: The endpoints of Redpanda HTTP Proxy or Schema Registry.
properties:
mtls:
description: URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
type: string
private_link_mtls:
description: URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.
type: string
private_link_sasl:
description: URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.
type: string
sasl:
description: URL of the seed broker for SASL. If SASL is not enabled, the field is empty.
type: string
type: object
ErrorInfo:
description: |-
Describes the cause of the error with structured details.
Expand Down Expand Up @@ -1290,8 +1327,8 @@ components:
HTTPProxyStatus:
description: HTTP Proxy properties.
properties:
all_seed_brokers:
$ref: '#/components/schemas/SeedBrokers'
all_urls:
$ref: '#/components/schemas/Endpoints'
mtls:
$ref: '#/components/schemas/MTLSSpec'
sasl:
Expand All @@ -1317,16 +1354,6 @@ components:
type: array
title: Help
type: object
InstanceProfile:
description: AWS instance profile.
properties:
arn:
description: AWS instance profile ARN.
type: string
required:
- arn
title: Instance Profile
type: object
KafkaAPISpec:
description: Cluster's Kafka API properties.
properties:
Expand Down Expand Up @@ -2180,16 +2207,7 @@ components:
name:
type: string
type: object
SecurityGroups:
description: Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
properties:
redpanda_security_group:
$ref: '#/components/schemas/SecurityGroups.SecurityGroup'
required:
- redpanda_security_group
title: Azure Security Groups
type: object
SecurityGroups.SecurityGroup:
SecurityGroup:
description: Azure security group.
properties:
name:
Expand All @@ -2200,8 +2218,17 @@ components:
required:
- name
type: object
SecurityGroups:
description: Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.
properties:
redpanda_security_group:
$ref: '#/components/schemas/SecurityGroup'
required:
- redpanda_security_group
title: Azure Security Groups
type: object
SeedBrokers:
description: Seed brokers of a Redpanda API Endpoint.
description: Seed brokers of Redpanda Kafka API.
properties:
mtls:
description: URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.
Expand Down Expand Up @@ -2760,31 +2787,35 @@ components:
description: AWS resources created and managed by user, and required to deploy the Redpanda cluster.
properties:
agent_instance_profile:
$ref: '#/components/schemas/InstanceProfile'
$ref: '#/components/schemas/AWSInstanceProfile'
cloud_storage_bucket:
$ref: '#/components/schemas/CustomerManagedAWSCloudStorageBucket'
cluster_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
connectors_node_group_instance_profile:
$ref: '#/components/schemas/InstanceProfile'
$ref: '#/components/schemas/AWSInstanceProfile'
connectors_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
k8s_cluster_role:
$ref: '#/components/schemas/AWS.Role'
node_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
permissions_boundary_policy:
$ref: '#/components/schemas/Policy'
redpanda_agent_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
redpanda_connect_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
redpanda_connect_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
redpanda_node_group_instance_profile:
$ref: '#/components/schemas/InstanceProfile'
$ref: '#/components/schemas/AWSInstanceProfile'
redpanda_node_group_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
utility_node_group_instance_profile:
$ref: '#/components/schemas/InstanceProfile'
$ref: '#/components/schemas/AWSInstanceProfile'
utility_security_group:
$ref: '#/components/schemas/AWS.SecurityGroup'
$ref: '#/components/schemas/AWSSecurityGroup'
required:
- agent_instance_profile
- connectors_node_group_instance_profile
Expand Down Expand Up @@ -2933,7 +2964,7 @@ openapi: 3.0.3
paths:
/v1/clusters:
get:
description: List Redpanda clusters. The `filter.` query string parameters find matching clusters that meet all specified conditions.
description: 'List Redpanda clusters. The `filter.` query string parameters find matching clusters that meet all specified conditions. Note: This endpoint does not return `dataplane_api.url`. Use the Get Cluster endpoint to retrieve a cluster''s Data Plane API URL.'
operationId: ClusterService_ListClusters
parameters:
- description: Resource group ID.
Expand Down Expand Up @@ -2995,7 +3026,7 @@ paths:
dataplane_api: null
desired_redpanda_version: ""
http_proxy:
all_seed_brokers: null
all_urls: null
mtls:
ca_certificates_pem: []
enabled: false
Expand All @@ -3022,7 +3053,7 @@ paths:
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
schema_registry:
all_seed_brokers: null
all_urls: null
mtls: null
sasl: null
url: schema-registry-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092
Expand Down Expand Up @@ -3327,7 +3358,7 @@ paths:
dataplane_api: null
desired_redpanda_version: ""
http_proxy:
all_seed_brokers: null
all_urls: null
mtls:
ca_certificates_pem: []
enabled: false
Expand All @@ -3354,7 +3385,7 @@ paths:
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
schema_registry:
all_seed_brokers: null
all_urls: null
mtls: null
sasl: null
url: schema-registry-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092
Expand Down Expand Up @@ -3721,7 +3752,7 @@ paths:
dataplane_api: null
desired_redpanda_version: ""
http_proxy:
all_seed_brokers: null
all_urls: null
mtls:
ca_certificates_pem: []
enabled: false
Expand All @@ -3748,7 +3779,7 @@ paths:
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
schema_registry:
all_seed_brokers: null
all_urls: null
mtls: null
sasl: null
url: schema-registry-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092
Expand Down Expand Up @@ -3845,7 +3876,7 @@ paths:
dataplane_api: null
desired_redpanda_version: ""
http_proxy:
all_seed_brokers: null
all_urls: null
mtls:
ca_certificates_pem: []
enabled: false
Expand All @@ -3872,7 +3903,7 @@ paths:
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
schema_registry:
all_seed_brokers: null
all_urls: null
mtls: null
sasl: null
url: schema-registry-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092
Expand Down