Skip to content

Conversation

@vbotbuildovich
Copy link
Contributor

@vbotbuildovich vbotbuildovich commented Oct 13, 2025

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 4280d2aa137f6bb46e72716d7a43ae0fd43714f9

@github-actions
Copy link

github-actions bot commented Oct 13, 2025

🤖 API structural change detected:

Modified (1)

  • PUT /v1/secrets/{id}
    • Content type modified: application/json
      • Property modified: secret_data
        • Property is no longer required

Preview documentation

Powered by Bump.sh

@coderabbitai
Copy link

coderabbitai bot commented Oct 13, 2025

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.

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

📝 Walkthrough

Walkthrough

The PR updates the cloud-dataplane OpenAPI specification with several textual description and capitalization changes (e.g., “Connect” vs “connect,” “Deploy Transform”). Example metadata in ErrorInfo is adjusted (projects/1234 → projects/123). A functional schema change removes secret_data from the required properties of UpdateSecretBody, altering the request body requirement for the UpdateSecret operation. Minor phrasing tweaks are applied across endpoints referencing the target connect cluster.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • JakeSCahill
  • kbatuigas

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly states the main change of updating the Cloud API specification via auto-generated documentation and directly reflects the primary modification in the pull request by referencing the Cloud API spec update.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Description Check ✅ Passed The author’s description clearly states that the PR updates the OpenAPI spec file for the Cloud API, matching the modifications in cloud-dataplane.yaml. It references the triggering commit for clarity. The description is relevant and on-topic.

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

@github-actions
Copy link

github-actions bot commented Oct 14, 2025

🚨 Breaking API change detected:

Modified (2)

  • GET /v1/serverless/clusters
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: serverless_clusters
          • Properties modified: dataplane_api, kafka_api, schema_registry
          • [Breaking] Property removed: console
            • Removing a resource is always breaking unless it was deprecated before [Breaking]
          • Properties added: console_private_url, network
  • GET /v1/serverless/clusters/{id}
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: dataplane_api
          • Property added: private_url
        • Property modified: kafka_api
          • Property added: private_seed_brokers
        • Property modified: schema_registry
          • Property added: private_url
        • [Breaking] Property removed: console
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: console_private_url, network

Preview documentation

Powered by Bump.sh

@kbatuigas kbatuigas merged commit 25b10f3 into main Oct 18, 2025
8 checks passed
@kbatuigas kbatuigas deleted the update-branch-api branch October 18, 2025 05:45
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.

3 participants