auto-docs: Update Cloud API spec #20
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe control plane OpenAPI (cloud-controlplane.yaml) adds three new Operation.Type enum values for serverless private link operations (create, update, delete) and updates ListOperations filter.type_in accordingly. The info.description is revised to a broader scope including clusters, networks, and resource groups. The data plane OpenAPI (cloud-dataplane.yaml) undergoes documentation-only edits: capitalization and phrasing standardization across many endpoints (connect, topics, secrets, roles, transforms), minor punctuation adjustments, an updated doc link for ACLs, and removal of a top-level info description line. No API paths, parameters, or schemas change in the data plane spec. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
✨ Finishing touches🧪 Generate unit tests
Comment |
|
ℹ️ API content change detected: No structural change, nothing to display.
|
|
ℹ️ API content change detected: No structural change, nothing to display.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
cloud-controlplane/cloud-controlplane.yaml (2)
3261-3261: Nit: broaden info.description to reflect serverless/private linkOptional wording tweak to reflect newly documented areas.
- description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups. + description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, resource groups, and serverless features such as Private Link.
178-179: Clean up typos and wording in user-facing textThese small fixes improve polish without changing the API surface.
- title: dns_a_dns_a_recordrecord is the DNS A record the customer will create pointing at the their PE + title: dns_a_record is the DNS A record the customer will create pointing at their Private Endpoint- title: |- - GetAvalableOrganizationsResponse the response of the the - GetAvalableOrganizations rpc + title: |- + ListAvailableOrganizationsResponse is the response of the + ListAvailableOrganizations RPC- title: Azure Resoure Groups + title: Azure Resource Groups- description: Azure subnets used by Redpand cluster deployment. + description: Azure subnets used by Redpanda cluster deployment.- description: |- - UpdateClusterResponse is the resposne of UpdateCluster. It is provided by + description: |- + UpdateClusterResponse is the response of UpdateCluster. It is provided by- title: AWS Customer-Managed Resoures + title: AWS Customer-Managed Resources- title: GCP Customer-Managed Resoures + title: GCP Customer-Managed Resources- title: Azure Customer-Managed Resoures + title: Azure Customer-Managed ResourcesAlso applies to: 1536-1538, 2417-2417, 2705-2705, 2804-2806, 999-1000, 1020-1021, 3155-3156
cloud-dataplane/cloud-dataplane.yaml (4)
2813-2841: Unify “Kafka Connect” product naming and summary capitalization.Use the proper product name “Kafka Connect” and consistent Title Case in summaries across these endpoints and parameters.
Apply:
- description: List connect clusters available for being consumed by the console's kafka-connect service. + description: List Kafka Connect clusters available to the Console's Kafka Connect service. - summary: List connect clusters + summary: List Kafka Connect Clusters - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Kafka Connect cluster. For Redpanda Cloud, use `redpanda`. - summary: Get connect cluster + summary: Get Kafka Connect Cluster - summary: List Connect Cluster Secrets + summary: List Kafka Connect Cluster Secrets - summary: Create Connect Cluster Secret + summary: Create Kafka Connect Cluster Secret - summary: Delete Connect Cluster Secret + summary: Delete Kafka Connect Cluster Secret - summary: Get Connect Cluster Secret + summary: Get Kafka Connect Cluster Secret - summary: Update Connect Cluster Secret + summary: Update Kafka Connect Cluster SecretAnd for the repeated path params at the indicated ranges (pause, restart, resume, status, stop, topics, reset, secrets), replace “target connect cluster” with “target Kafka Connect cluster” similarly.
Also applies to: 2848-2886, 3177-3183, 3222-3232, 3273-3283, 3316-3327, 3362-3372, 3406-3416, 3451-3462, 3495-3500, 3558-3560, 3603-3606, 3611-3623, 3653-3656, 3703-3706, 3760-3763
215-216: Clarify cluster name description.Minor wording polish for accuracy.
- description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of the Kafka Connect cluster. For Redpanda Cloud, the value is `redpanda`.
5353-5355: Pluralize for consistency with adjacent endpoints.Surrounding summaries use “Configurations”; use plural here too.
- summary: Update Topic Configuration + summary: Update Topic Configurations
4554-4568: Lowercase common noun in description.“Role” isn’t a proper noun here.
- description: Delete a Role. + description: Delete a role.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
cloud-controlplane/cloud-controlplane.yaml(3 hunks)cloud-dataplane/cloud-dataplane.yaml(49 hunks)
🔇 Additional comments (4)
cloud-controlplane/cloud-controlplane.yaml (2)
2002-2004: Additions to Operation.Type look good; confirm metadata/response wiring existsThe three new enum values are consistent. Please verify whether corresponding OperationMetadata/OperationResponse oneOf variants (e.g., create/update/delete serverless private link) are needed and, if so, add them; otherwise clients may lack typed metadata/response for these operations.
3967-3969: ListOperations filter updated correctlyThe new operation types are exposed in
filter.type_in. LGTM.cloud-dataplane/cloud-dataplane.yaml (2)
6021-6023: LGTM: ACL doc link update.The updated Users tag now points to the ACL GET anchor. Looks correct and helpful.
2228-2230: Doc-only changes look safe, but the OpenAPI validation script failed to import the validator. Please update the validation step—ensureopenapi-spec-validatoris installed in the correct Python environment or use theopenapi-spec-validatorCLI—and confirm the spec remains 3.0.3-compliant.
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
a5320bf to
e8632fd
Compare
|
Status: Reached out to cloud API team regarding integration of console/Data Plane API changes to cloudv2 |
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
e8632fd to
3d22c2b
Compare
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: ca7909f7d8134b7ff1fc68c9278540765e7cb44a