auto-docs: Update Cloud API spec

[vbotbuildovich]

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 793070d9fa84a649f97d3c4c8c841897456f0f5a

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a98e2964-196e-4270-835b-a5a52e514aea

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

This PR updates two OpenAPI specification files. In cloud-controlplane.yaml, it adds new GCP RPSQL-related properties (rpsql_api_service_account, rpsql_cloud_storage_bucket, rpsql_secret_manager_prefix, rpsql_service_account) to the CustomerManagedResourcesUpdate.GCP schema and rpsql_secret_manager_prefix to the v1 CustomerManagedResources.GCP schema, with documentation describing the Secret Manager resource-path format for Iceberg catalog credentials. In cloud-dataplane.yaml, it changes the summary text of the TransformService_DeployTransform operation from "Deploy transform" to "Deploy Transform".

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• redpanda-data/api-docs#49: Same capitalization change to the TransformService_DeployTransform summary in cloud-dataplane.yaml.
• redpanda-data/api-docs#64: Same capitalization change to the TransformService_DeployTransform summary in cloud-dataplane.yaml.
• redpanda-data/api-docs#66: Same capitalization change to the TransformService_DeployTransform summary in cloud-dataplane.yaml.

Suggested reviewers: kbatuigas

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title clearly summarizes the main change: updating the Cloud API spec.
Description check	✅ Passed	The description is directly related and accurately states that the OpenAPI spec file was updated.

✨ 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.}

[github-actions]

ℹ️ Cloud Data Plane API API content change detected

Preview documentation

No structural change, nothing to display.

Powered by Bump.sh

[github-actions]

🤖 Cloud Control Plane API API structural change detected

Preview documentation

Structural change details

Modified (20)

• DELETE /v1/clusters/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• DELETE /v1/network/{network_id}/network-peerings/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• DELETE /v1/networks/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• DELETE /v1/serverless/clusters/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• DELETE /v1/serverless/private-links/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• DELETE /v1/shadow-links/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• 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
• GET /v1/operations
  • Response modified: 200
    • Content type modified: application/json
      • Property modified: operations
        • Property modified: response
• GET /v1/operations/{id}
  • Response modified: 200
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• PATCH /v1/clusters/{cluster.id}
  • Content type modified: application/json
    • Property modified: customer_managed_resources
      • Property modified: gcp
        • Properties added: rpsql_api_service_account, rpsql_cloud_storage_bucket, rpsql_secret_manager_prefix, rpsql_service_account
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: customer_managed_resources
        • Property modified: gcp
• PATCH /v1/networks/{network.id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• PATCH /v1/serverless/private-links/{id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• PATCH /v1/shadow-links/{shadow_link.id}
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/clusters
  • Content type modified: application/json
    • Property modified: cluster
      • Property modified: customer_managed_resources
        • Property modified: gcp
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/network/{network_peering.network_id}/network-peerings
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/networks
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/serverless/clusters
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/serverless/private-links
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response
• POST /v1/shadow-links
  • Response modified: 202
    • Content type modified: application/json
      • Property modified: operation
        • Property modified: response

Powered by Bump.sh

[coderabbitai]

🧹 Nitpick comments (1)

cloud-dataplane/cloud-dataplane.yaml (1)

7859-7859: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Casing inconsistent with sibling "Wasm Transforms" summaries.

Other operations under the same tag use lowercase nouns: List transforms, Delete transform, Get transform. This change makes Deploy Transform the outlier. If intentional, fine; otherwise revert to Deploy transform for consistency. Since this file is auto-generated, the actual fix should be applied upstream in the cloudv2 source annotation.

✏️ Suggested casing fix (apply upstream)

-      summary: Deploy Transform
+      summary: Deploy transform

🤖 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-dataplane/cloud-dataplane.yaml` at line 7859, The operation summary for
the Deploy action is inconsistent with the other Wasm Transforms summaries,
which all use lowercase nouns. Update the upstream `cloudv2` source annotation
that generates this OpenAPI entry so `Deploy Transform` becomes `Deploy
transform`, keeping it aligned with `List transforms`, `Delete transform`, and
`Get transform`.

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

Nitpick comments:
In `@cloud-dataplane/cloud-dataplane.yaml`:
- Line 7859: The operation summary for the Deploy action is inconsistent with
the other Wasm Transforms summaries, which all use lowercase nouns. Update the
upstream `cloudv2` source annotation that generates this OpenAPI entry so
`Deploy Transform` becomes `Deploy transform`, keeping it aligned with `List
transforms`, `Delete transform`, and `Get transform`.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 43f7cb1c-50cd-461b-abba-e027a4f1ab9c

📥 Commits

Reviewing files that changed from the base of the PR and between 4d2ef7c and 3f0b231.

📒 Files selected for processing (2)

• cloud-controlplane/cloud-controlplane.yaml
• cloud-dataplane/cloud-dataplane.yaml