auto-docs: Update Cloud API spec #11
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🚨 Breaking API change detected: Added (1)
Modified (13)
|
|
🚨 Breaking API change detected: Added (12)
Modified (63)
|
vbotbuildovich
force-pushed
the
update-branch-api
branch
5 times, most recently
from
5523c74 to
96105da
Compare
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
96105da to
2c64146
Compare
|
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 📝 WalkthroughWalkthrough
Sequence Diagram(s)sequenceDiagram
participant Client
participant API as Control Plane API
participant OrgSvc as Organization Service
participant DB
Client->>API: PATCH /v1/organizations/current (OrganizationUpdate)
API->>OrgSvc: Validate and forward update (mfa_enforced)
OrgSvc->>DB: Update organization settings
DB-->>OrgSvc: Persisted organization
OrgSvc-->>API: Updated Organization
API-->>Client: 200 OK (ListAvailableOrganizationsResponse)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
cloud-controlplane/x-topics/cloud-regions.md (3)
17-20: Add aria-describedby and unique ID for the sr-only description to improve a11y.Link the table to its hidden description. Example for the GCP section:
-<details><summary>Regions for GCP</summary> -<p class="sr-only">Table of cloud regions and throughput tiers for GCP. Use the table headers for more information.</p> -<table aria-label="Cloud regions and throughput tiers for GCP"> +<details><summary>Regions for GCP</summary> +<p id="gcp-regions-desc" class="sr-only">Table of cloud regions and throughput tiers for GCP. Use the table headers for more information.</p> +<table aria-label="Cloud regions and throughput tiers for GCP" aria-describedby="gcp-regions-desc">Apply the same pattern for AWS and Azure sections with unique IDs.
20-24: Use thead/tbody and header scopes for stronger table semantics.This improves screen reader support and aligns with accessible table best practices. Example for the GCP table:
- <tr> - <th title="Cloud region name (such as us-central1)">Region</th> - <th title="Availability zones in the region (comma-separated)">Zones</th> - <th title="Available throughput tiers and cluster types in this region">Throughput Tiers</th> - </tr> + <thead> + <tr> + <th scope="col" title="Cloud region name (such as us-central1)">Region</th> + <th scope="col" title="Availability zones in the region (comma-separated)">Zones</th> + <th scope="col" title="Available throughput tiers and cluster types in this region">Throughput Tiers</th> + </tr> + </thead> + <tbody>And close tbody before the table ends:
-</table> + </tbody> +</table>Consider applying the same structure to the AWS and Azure tables.
Also applies to: 348-351
29-41: Minor readability nit: comma-separated zone lists lack spaces.Optional formatting improvement for readability: add a space after commas in zone lists (for all providers).
Also applies to: 46-58
cloud-controlplane/cloud-controlplane.yaml (2)
328-334: Capitalize and clarify NAT gateway description.Use the standard acronym and clarify contents.
- nat_gateways: - description: Nat gateway information of the cluster. + nat_gateways: + description: NAT gateway information for the cluster. items: type: string readOnly: true type: array
5659-5689: Tag naming consistency: “User invites” differs in capitalization from other tags.Most tags are Title Case (“Resource Groups”, “Serverless Regions”). “User invites” uses lowercase invites. If there’s no strong reason, consider “User Invites” for consistency across docs and UI taxonomy.
📜 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(54 hunks)cloud-controlplane/x-topics/cloud-regions.md(1 hunks)
🔇 Additional comments (8)
cloud-controlplane/x-topics/cloud-regions.md (1)
16-24: LGTM: Collapsible sections and headers improve scannability and a11y.The shift to details/summary with an h3 heading plus sr-only descriptions is a solid improvement without altering data.
cloud-controlplane/cloud-controlplane.yaml (7)
3334-3334: Examples correctly include nat_gateways and reflect the new schema.Sample payloads align with the added read-only field on Cluster. No issues spotted.
Also applies to: 3669-3669, 4064-4064, 4189-4189
1444-1450: HTTPProxySpec docs updated to correct destinations. LGTM.References now point to the HTTP Proxy overview and API reference under docs.redpanda.com.
2438-2445: SchemaRegistrySpec docs updated to correct destinations. LGTM.References now point to Cloud Schema Registry docs and SR API reference under docs.redpanda.com.
3247-3249: Info description refinement reads better. LGTM.Clearer API overview without altering semantics.
2099-2113: OrganizationUpdate type addition looks correct.Adding mfa_enforced to Organization and OrganizationUpdate matches the intent. No breaking changes observed.
2802-2806: New UpdateOrganizationResponse is well-scoped.Returning the updated Organization object under a dedicated response type is clear and consistent.
1-5689: Internet Gateways References RemovedVerified that there are no remaining occurrences of
internet_gatewaysincloud-controlplane/cloud-controlplane.yaml. The spec no longer contains any stale references to internet gateways.
| @@ -572,7 +572,7 @@ components: | |||
| schema_registry: | |||
| $ref: '#/components/schemas/SchemaRegistrySpec' | |||
| throughput_tier: | |||
| description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |||
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Good docs link consolidation for throughput_tier, but ensure URL consistency across file.
This updates the anchor to Control Plane API docs. Elsewhere (for example, Create Cluster description on Line 3375) the link uses a .html suffix. Please standardize to one canonical URL to avoid broken links.
Run a quick check to find and review all Control Plane API doc links that include “cloud-controlplane-api”:
If both .html and non-.html variants appear and both resolve, pick one convention and update for consistency.
🏁 Script executed:
#!/bin/bash
rg -n -C2 -e 'cloud-controlplane-api(\.html)?#api-description' -e 'cloud-controlplane-api(\.html)?' -- cloud-controlplane/cloud-controlplane.yamlLength of output: 1406
Standardize Control Plane API URL suffix
The throughput_tier description at line 575 uses the non-.html variant, while the “Regions” link at line 3375 uses the .html suffix. To avoid confusion and potential broken links, pick one canonical form—preferably the .html version—and apply it consistently:
• File: cloud-controlplane/cloud-controlplane.yaml
– Line 575: update to the .html URL
• (Optional) Scan for any other occurrences of cloud-controlplane-api links and align them to the chosen suffix
Suggested change at line 575:
- description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster…'
+ description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) of the cluster…'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' |
🤖 Prompt for AI Agents
In cloud-controlplane/cloud-controlplane.yaml around line 575, the description
URL for the throughput_tier uses the non-.html variant of the
cloud-controlplane-api link; update that URL to the canonical .html form (i.e.,
change the endpoint to include .html) so it matches the Regions link style, and
optionally scan the file for other cloud-controlplane-api links to normalize
them to the chosen .html suffix for consistency.
Comment on lines
4303
to
4344
| description: Get a list of available organizations for the user. | ||
| operationId: OrganizationService_UpdateOrganization | ||
| requestBody: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/OrganizationUpdate' | ||
| required: true | ||
| x-originalParamName: organization | ||
| responses: | ||
| "200": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/ListAvailableOrganizationsResponse' | ||
| description: OK | ||
| "500": | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/rpc.Status' | ||
| description: Internal Server Error. Please reach out to support. | ||
| default: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/rpc.Status' | ||
| description: An unexpected error response. | ||
| summary: List available organizations for the user | ||
| tags: | ||
| - Organization |
There was a problem hiding this comment.
PATCH /v1/organizations/current: incorrect description, response schema, and summary.
This endpoint is an update, but:
- Description says “Get a list of available organizations for the user.”
- Response schema is ListAvailableOrganizationsResponse.
- Summary duplicates the ListAvailable... phrasing.
These are contract errors and will mislead SDK generators and consumers. It should return the updated organization (UpdateOrganizationResponse or Organization) and have an update-oriented description/summary.
Apply the following fix:
/v1/organizations/current:
@@
- patch:
- description: Get a list of available organizations for the user.
+ patch:
+ description: Update properties of the current organization.
operationId: OrganizationService_UpdateOrganization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationUpdate'
required: true
- x-originalParamName: organization
+ x-originalParamName: organization
responses:
"200":
content:
application/json:
schema:
- $ref: '#/components/schemas/ListAvailableOrganizationsResponse'
+ $ref: '#/components/schemas/UpdateOrganizationResponse'
description: OK
@@
- summary: List available organizations for the user
+ summary: Update current organization
tags:
- OrganizationOptionally, consider returning GetCurrentOrganizationResponse for 200 if you prefer reusing an existing envelope, but keep description/summary aligned with “update”.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| description: Get a list of available organizations for the user. | |
| operationId: OrganizationService_UpdateOrganization | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/OrganizationUpdate' | |
| required: true | |
| x-originalParamName: organization | |
| responses: | |
| "200": | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ListAvailableOrganizationsResponse' | |
| description: OK | |
| "500": | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpc.Status' | |
| description: Internal Server Error. Please reach out to support. | |
| default: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpc.Status' | |
| description: An unexpected error response. | |
| summary: List available organizations for the user | |
| tags: | |
| - Organization | |
| patch: | |
| description: Update properties of the current organization. | |
| operationId: OrganizationService_UpdateOrganization | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/OrganizationUpdate' | |
| required: true | |
| x-originalParamName: organization | |
| responses: | |
| "200": | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UpdateOrganizationResponse' | |
| description: OK | |
| "500": | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpc.Status' | |
| description: Internal Server Error. Please reach out to support. | |
| default: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpc.Status' | |
| description: An unexpected error response. | |
| summary: Update current organization | |
| tags: | |
| - Organization |
🤖 Prompt for AI Agents
In cloud-controlplane/cloud-controlplane.yaml around lines 4303 to 4333, the
PATCH /v1/organizations/current operation is misdocumented as a "list" endpoint:
update the description to reflect that this is an update of the current
organization (e.g., "Update the current organization for the user."), change the
200 response schema from ListAvailableOrganizationsResponse to an appropriate
update envelope (e.g., UpdateOrganizationResponse or Organization or
GetCurrentOrganizationResponse if reusing an existing envelope), and update the
summary to an update-oriented phrase ("Update current organization"); also
ensure operationId matches (OrganizationService_UpdateOrganization or similar)
and remove any lingering references to listing to keep the contract consistent
for SDK generators and consumers.
There was a problem hiding this comment.
There was a problem hiding this comment.
@kbatuigas, thank you for addressing the issue! I appreciate you providing the link to the fix in the source repository. This resolves the API documentation inconsistency I identified with the PATCH /v1/organizations/current endpoint.
(\ /)
( ._. )
o_(")(") *satisfied rabbit*
kbatuigas
reviewed
Aug 19, 2025
| @@ -331,6 +325,12 @@ components: | |||
| description: Unique name of the cluster. | |||
| example: development-cluster | |||
| type: string | |||
| nat_gateways: | |||
| description: Nat gateway information of the cluster. | |||
There was a problem hiding this comment.
Suggested change
| description: Nat gateway information of the cluster. | |
| description: NAT gateway information for the cluster. |
kbatuigas
reviewed
Aug 19, 2025
| @@ -572,7 +572,7 @@ components: | |||
| schema_registry: | |||
| $ref: '#/components/schemas/SchemaRegistrySpec' | |||
| throughput_tier: | |||
| description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |||
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |||
There was a problem hiding this comment.
Suggested change
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | |
| description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' |
kbatuigas
reviewed
Aug 19, 2025
| @@ -1441,7 +1441,7 @@ components: | |||
| $ref: '#/components/schemas/User' | |||
| type: object | |||
| HTTPProxySpec: | |||
| description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/doc/http-proxy) for more information. | |||
| description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/pandaproxy-rest) for more information. | |||
There was a problem hiding this comment.
Suggested change
| description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/pandaproxy-rest) for more information. | |
| description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/doc/http-proxy) for more information. |
kbatuigas
reviewed
Aug 19, 2025
| @@ -2428,7 +2435,7 @@ components: | |||
| title: SASL configuration | |||
| type: object | |||
| SchemaRegistrySpec: | |||
| description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/doc/schema-registry) for more information. | |||
| description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/pandaproxy-schema-registry) for more information. | |||
There was a problem hiding this comment.
Suggested change
| description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/pandaproxy-schema-registry) for more information. | |
| description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/doc/schema-registry) for more information. |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3232,7 +3244,7 @@ components: | |||
| x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap | |||
| type: oauth2 | |||
| info: | |||
| description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' | |||
| description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups. | |||
There was a problem hiding this comment.
Suggested change
| description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups. | |
| description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' |
kbatuigas
reviewed
Aug 19, 2025
| tags: | ||
| - Clusters | ||
| post: | ||
| description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). | ||
| description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). |
There was a problem hiding this comment.
Suggested change
| description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). | |
| description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3445,7 +3457,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Create cluster | |||
| summary: Create Cluster | |||
There was a problem hiding this comment.
Suggested change
| summary: Create Cluster | |
| summary: Create cluster |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3563,7 +3575,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Update cluster | |||
| summary: Update Cluster | |||
There was a problem hiding this comment.
Suggested change
| summary: Update Cluster | |
| summary: Update cluster |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3606,7 +3618,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Delete cluster | |||
| summary: Delete Cluster | |||
There was a problem hiding this comment.
Suggested change
| summary: Delete Cluster | |
| summary: Delete cluster |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3696,7 +3708,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Get cluster | |||
| summary: Get Cluster | |||
There was a problem hiding this comment.
Suggested change
| summary: Get Cluster | |
| summary: Get cluster |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3769,7 +3781,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: List networks | |||
| summary: List Networks | |||
There was a problem hiding this comment.
Suggested change
| summary: List Networks | |
| summary: List networks |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3826,7 +3838,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Create network | |||
| summary: Create Network | |||
There was a problem hiding this comment.
Suggested change
| summary: Create Network | |
| summary: Create network |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3869,7 +3881,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Delete network | |||
| summary: Delete Network | |||
There was a problem hiding this comment.
Suggested change
| summary: Delete Network | |
| summary: Delete network |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3916,7 +3928,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Please reach out to support. | |||
| summary: Get network | |||
| summary: Get Network | |||
There was a problem hiding this comment.
Suggested change
| summary: Get Network | |
| summary: Get network |
kbatuigas
reviewed
Aug 19, 2025
| @@ -3988,7 +4000,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: An unexpected error response. | |||
| summary: List operations | |||
| summary: List Operations | |||
There was a problem hiding this comment.
Suggested change
| summary: List Operations | |
| summary: List operations |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4433,7 +4477,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Reach out to support. | |||
| summary: List resource groups | |||
| summary: List Resource Groups | |||
There was a problem hiding this comment.
Suggested change
| summary: List Resource Groups | |
| summary: List resource groups |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4468,7 +4512,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Reach out to support. | |||
| summary: Create resource group | |||
| summary: Create Resource Group | |||
There was a problem hiding this comment.
Suggested change
| summary: Create Resource Group | |
| summary: Create resource group |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4495,7 +4539,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Not Found | |||
| summary: Delete resource group | |||
| summary: Delete Resource Group | |||
There was a problem hiding this comment.
Suggested change
| summary: Delete Resource Group | |
| summary: Delete resource group |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4538,7 +4582,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Reach out to support. | |||
| summary: Get resource group | |||
| summary: Get Resource Group | |||
There was a problem hiding this comment.
Suggested change
| summary: Get Resource Group | |
| summary: Get resource group |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4589,7 +4633,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: Internal Server Error. Reach out to support. | |||
| summary: Update resource group | |||
| summary: Update Resource Group | |||
There was a problem hiding this comment.
Suggested change
| summary: Update Resource Group | |
| summary: Update resource group |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4654,7 +4698,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: An unexpected error response. | |||
| summary: List role bindings | |||
| summary: List Role Bindings | |||
There was a problem hiding this comment.
Suggested change
| summary: List Role Bindings | |
| summary: List role bindings |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4687,7 +4731,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: An unexpected error response. | |||
| summary: Create role binding | |||
| summary: Create Role Binding | |||
There was a problem hiding this comment.
Suggested change
| summary: Create Role Binding | |
| summary: Create role binding |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4718,7 +4762,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: An unexpected error response. | |||
| summary: Delete role binding | |||
| summary: Delete Role Binding | |||
There was a problem hiding this comment.
Suggested change
| summary: Delete Role Binding | |
| summary: Delete role binding |
kbatuigas
reviewed
Aug 19, 2025
| @@ -4755,7 +4799,7 @@ paths: | |||
| schema: | |||
| $ref: '#/components/schemas/rpc.Status' | |||
| description: An unexpected error response. | |||
| summary: Get role binding | |||
| summary: Get Role Binding | |||
There was a problem hiding this comment.
Suggested change
| summary: Get Role Binding | |
| summary: Get role binding |
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
2c64146 to
1e08452
Compare
vbotbuildovich
force-pushed
the
update-branch-api
branch
2 times, most recently
from
275f608 to
eff7f15
Compare
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
eff7f15 to
6b26436
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 56e7dc4ea7e5d68a8d549908341ee39def366ee6