Skip to content

auto-docs: Update Cloud API spec #66

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.

Sign up for GitHub

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

Open
vbotbuildovich wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −9
Open

auto-docs: Update Cloud API spec #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions cloud-controlplane/cloud-controlplane.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1379,12 +1379,12 @@ components:
properties:
oxla_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
oxla_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
redpanda_connect_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
redpanda_connect_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
rpsql_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
title: AWS Customer-Managed Resoures
type: object
CustomerManagedResourcesUpdate.GCP:
Expand Down Expand Up @@ -4735,8 +4735,6 @@ components:
$ref: '#/components/schemas/AWSSecurityGroup'
oxla_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
oxla_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
permissions_boundary_policy:
$ref: '#/components/schemas/Policy'
redpanda_agent_security_group:
Expand All @@ -4749,6 +4747,8 @@ components:
$ref: '#/components/schemas/AWSInstanceProfile'
redpanda_node_group_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
rpsql_security_group:
$ref: '#/components/schemas/AWSSecurityGroup'
utility_node_group_instance_profile:
$ref: '#/components/schemas/AWSInstanceProfile'
utility_security_group:
Expand Down Expand Up @@ -5299,7 +5299,6 @@ paths:
name: my-new-cluster
nat_gateways: []
network_id: cjb69k1c4vs45df9bee0
oxla: null
prometheus:
url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
read_replica_cluster_ids: []
Expand All @@ -5308,6 +5307,7 @@ paths:
redpanda_node_count: 0
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
rpsql: null
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Move this renamed field under customer_managed_resources.aws and keep the full property name.

These examples now show a top-level rpsql: null, but the schema change added rpsql_security_group under customer_managed_resources.aws. As written, the examples no longer match the referenced Cluster schema and document the wrong response shape.

Also applies to: 5653-5653, 6462-6462, 6593-6593

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cloud-controlplane/cloud-controlplane.yaml` at line 5310, The example YAML
uses a top-level field rpsql: null which no longer matches the Cluster schema;
move this field under the customer_managed_resources.aws mapping and rename it
to the full property name rpsql_security_group (i.e.,
customer_managed_resources.aws.rpsql_security_group: null) so the examples match
the updated schema; apply the same change for the other occurrences noted (the
instances at the other example locations).

sandbox: null
schema_registry:
all_urls: null
Expand Down Expand Up @@ -5642,7 +5642,6 @@ paths:
name: my-new-cluster
nat_gateways: []
network_id: cjb69k1c4vs45df9bee0
oxla: null
prometheus:
url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
read_replica_cluster_ids: []
Expand All @@ -5651,6 +5650,7 @@ paths:
redpanda_node_count: 0
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
rpsql: null
sandbox: null
schema_registry:
all_urls: null
Expand Down Expand Up @@ -6451,7 +6451,6 @@ paths:
name: my-new-cluster
nat_gateways: []
network_id: cjb69k1c4vs45df9bee0
oxla: null
prometheus:
url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
read_replica_cluster_ids: []
Expand All @@ -6460,6 +6459,7 @@ paths:
redpanda_node_count: 0
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
rpsql: null
sandbox: null
schema_registry:
all_urls: null
Expand Down Expand Up @@ -6582,7 +6582,6 @@ paths:
name: my-new-cluster
nat_gateways: []
network_id: cjb69k1c4vs45df9bee0
oxla: null
prometheus:
url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics
read_replica_cluster_ids: []
Expand All @@ -6591,6 +6590,7 @@ paths:
redpanda_node_count: 0
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
rpsql: null
sandbox: null
schema_registry:
all_urls: null
Expand Down
2 changes: 1 addition & 1 deletion cloud-dataplane/cloud-dataplane.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7856,7 +7856,7 @@ paths:
schema:
$ref: '#/components/schemas/TransformMetadata'
description: Created
summary: Deploy transform
summary: Deploy Transform
tags:
- Wasm Transforms
/v1/transforms/{name}:
Expand Down
Loading