Skip to content

auto-docs: Update Cloud API spec#66

Open
vbotbuildovich wants to merge 1 commit into
mainfrom
update-branch-api
Open

auto-docs: Update Cloud API spec#66
vbotbuildovich wants to merge 1 commit into
mainfrom
update-branch-api

Conversation

@vbotbuildovich
Copy link
Copy Markdown
Contributor

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 256fa8df12e2e105f213b35f8902652a6f1983f0

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates the OpenAPI documentation for the Redpanda Cloud API. The primary change renames the AWS customer-managed resource security group field from oxla_security_group to rpsql_security_group in two schema definitions within the control plane API, affecting both the update and retrieval schemas. All related example payloads in cluster listing, cluster retrieval, and operation completion responses are updated to reflect this field name change. An unrelated minor capitalization fix updates the operation summary for the TransformService_DeployTransform operation in the data plane API.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • redpanda-data/api-docs#27: Both PRs modify cloud-dataplane/cloud-dataplane.yaml by changing the TransformService_DeployTransform operation summary capitalization.
  • redpanda-data/api-docs#49: Both PRs update the TransformService_DeployTransform operation summary text in cloud-dataplane/cloud-dataplane.yaml.
  • redpanda-data/api-docs#64: Both PRs update the TransformService_DeployTransform operation summary capitalization in cloud-dataplane/cloud-dataplane.yaml.

Suggested reviewers

  • JakeSCahill
  • kbatuigas
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'auto-docs: Update Cloud API spec' directly relates to the main changeset, which updates OpenAPI schemas and examples in the Cloud API specification files.
Description check ✅ Passed The description accurately states that the PR updates the OpenAPI spec file for the Cloud API and provides context about the triggering commit.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-branch-api

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown

ℹ️ Redpanda/cloud-dataplane API content change detected

Preview documentation

No structural change, nothing to display.

Powered by Bump.sh

@github-actions
Copy link
Copy Markdown

🚨 Breaking Redpanda/cloud-controlplane API change detected

Preview documentation

Structural change details

Modified (4)

  • GET /v1/clusters
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: clusters
          • Property modified: customer_managed_resources
  • GET /v1/clusters/{id}
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: cluster
          • Property modified: customer_managed_resources
  • PATCH /v1/clusters/{cluster.id}
    • Content type modified: application/json
      • Property modified: customer_managed_resources
        • Property modified: aws
          • [Breaking] Property removed: oxla_security_group
            • Removing a resource is always breaking unless it was deprecated before [Breaking]
          • Property added: rpsql_security_group
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: customer_managed_resources
          • Property modified: aws
  • POST /v1/clusters
    • Content type modified: application/json
      • Property modified: cluster
        • Property modified: customer_managed_resources
          • Property modified: aws
Powered by Bump.sh

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8128ad7 and 0241f88.

📒 Files selected for processing (2)
  • cloud-controlplane/cloud-controlplane.yaml
  • cloud-dataplane/cloud-dataplane.yaml

redpanda_node_count: 0
region: us-west1
resource_group_id: 6c09e47b-f426-4ec7-a7b4-8048caf8ae47
rpsql: null
Copy link
Copy Markdown

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant