auto-docs: Update Cloud API spec#66
Conversation
📝 WalkthroughWalkthroughThis PR updates the OpenAPI documentation for the Redpanda Cloud API. The primary change renames the AWS customer-managed resource security group field from Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
ℹ️ Redpanda/cloud-dataplane API content change detectedNo structural change, nothing to display. Powered by Bump.sh |
🚨 Breaking Redpanda/cloud-controlplane API change detectedStructural change detailsModified (4)
Powered by Bump.sh |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@cloud-controlplane/cloud-controlplane.yaml`:
- 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).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0ad7befc-574a-4d40-b449-3d8689a59d9d
📒 Files selected for processing (2)
cloud-controlplane/cloud-controlplane.yamlcloud-dataplane/cloud-dataplane.yaml
| redpanda_node_count: 0 | ||
| region: us-west1 | ||
| resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47 | ||
| rpsql: null |
There was a problem hiding this comment.
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).
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 256fa8df12e2e105f213b35f8902652a6f1983f0