auto-docs: Update Cloud API spec

[vbotbuildovich]

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 42fbe4babcb844b98ea9c6ea0c1a58dfcb85722c

[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: ab5de570-162c-4ff1-b7bd-1dc16b11b20d

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 pull request updates two OpenAPI specifications. The main change adds new GCP cluster configuration fields to the control-plane schema to expose and control global access for the internal load balancer serving the Console/API Gateway endpoint. This includes a nullable boolean property on the Cluster schema and corresponding boolean properties on ClusterCreate and ClusterUpdate schemas, with updates to the PATCH endpoint request body. A secondary change corrects the operation summary text casing for the Transform deployment endpoint in the dataplane specification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• redpanda-data/api-docs#49: Updates the same "Deploy transform" → "Deploy Transform" capitalization in cloud-dataplane.yaml
• redpanda-data/api-docs#27: Changes "Deploy Transform" endpoint summary text capitalization in cloud-dataplane.yaml
• redpanda-data/api-docs#52: Updates the DeployTransform operation summary text capitalization in cloud-dataplane.yaml

Suggested reviewers

• kbatuigas
• JakeSCahill

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'auto-docs: Update Cloud API spec' accurately describes the main change of updating the Cloud API OpenAPI specification files.
Description check	✅ Passed	The description is directly related to the changeset, explaining that the PR updates the OpenAPI spec file for the Cloud API with a reference to 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]

🤖 Redpanda/cloud-controlplane API structural change detected

Preview documentation

Structural change details

Modified (19)

• 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 added: gcp_global_access_api_gateway_enabled
• GET /v1/clusters/{id}
  • Response modified: 200
    • Content type modified: application/json
      • Property modified: cluster
        • Property added: gcp_global_access_api_gateway_enabled
• 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 added: gcp_enable_global_access_api_gateway
  • Response modified: 202
    • Content type modified: application/json
      • Property added: gcp_enable_global_access_api_gateway
• 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 added: gcp_enable_global_access_api_gateway
  • 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