Skip to content

Commit a8b7f3f

Browse files
vbotbuildovichgithub-actions[bot]
vbotbuildovich
authored and
github-actions[bot]
committed
auto-docs: Update Cloud API spec
1 parent ea9875a commit a8b7f3f

2 files changed

Lines changed: 282 additions & 3 deletions

File tree

‎cloud-controlplane/cloud-controlplane.yaml‎

Lines changed: 281 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,17 @@ components:
10531053
cluster:
10541054
$ref: '#/components/schemas/Cluster'
10551055
type: object
1056+
CreateGroupRequest:
1057+
description: CreateGroupRequest is the request of CreateGroup.
1058+
properties:
1059+
group:
1060+
$ref: '#/components/schemas/GroupCreate'
1061+
type: object
1062+
CreateGroupResponse:
1063+
properties:
1064+
group:
1065+
$ref: '#/components/schemas/Group'
1066+
type: object
10561067
CreateNetworkMetadata:
10571068
description: Resource describing an in-progress CreateNetwork Operation.
10581069
properties:
@@ -1430,6 +1441,8 @@ components:
14301441
DeleteClusterResponse:
14311442
description: DeleteClusterResponse is the request of DeleteCluster.
14321443
type: object
1444+
DeleteGroupResponse:
1445+
type: object
14331446
DeleteNetworkMetadata:
14341447
description: Resource describing an in-progress DeleteNetwork Operation.
14351448
title: DeleteNetworkMetadata
@@ -1801,6 +1814,11 @@ components:
18011814
GetCurrentOrganizationResponse the response of the the
18021815
GetCurrentOrganization rpc
18031816
type: object
1817+
GetGroupResponse:
1818+
properties:
1819+
group:
1820+
$ref: '#/components/schemas/Group'
1821+
type: object
18041822
GetNetworkPeeringRequest:
18051823
properties:
18061824
id:
@@ -1894,6 +1912,46 @@ components:
18941912
user:
18951913
$ref: '#/components/schemas/User'
18961914
type: object
1915+
Group:
1916+
properties:
1917+
created_at:
1918+
format: date-time
1919+
type: string
1920+
description:
1921+
description: The description of the group.
1922+
example: Engineering team group for RBAC.
1923+
type: string
1924+
id:
1925+
type: string
1926+
name:
1927+
description: The unique name of the group.
1928+
example: engineering
1929+
type: string
1930+
type: object
1931+
GroupCreate:
1932+
properties:
1933+
description:
1934+
description: The description of the group.
1935+
example: Engineering team group for RBAC.
1936+
nullable: true
1937+
type: string
1938+
name:
1939+
description: The unique name of the group.
1940+
example: engineering
1941+
type: string
1942+
type: object
1943+
GroupUpdate:
1944+
properties:
1945+
description:
1946+
description: The description of the group.
1947+
example: Engineering team group for RBAC.
1948+
nullable: true
1949+
type: string
1950+
name:
1951+
description: The unique name of the group.
1952+
example: engineering
1953+
type: string
1954+
type: object
18971955
HTTPProxySpec:
18981956
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.
18991957
properties:
@@ -2034,6 +2092,23 @@ components:
20342092
description: Page token to fetch the next page. The value can be used as `next_page_token` in the next call to this endpoint.
20352093
type: string
20362094
type: object
2095+
ListGroupsRequest.Filter:
2096+
properties:
2097+
name:
2098+
type: string
2099+
type: object
2100+
ListGroupsResponse:
2101+
description: ListGroupsResponse is the response of ListGroups.
2102+
properties:
2103+
groups:
2104+
description: Groups matching the request
2105+
items:
2106+
$ref: '#/components/schemas/Group'
2107+
maxItems: 100
2108+
type: array
2109+
next_page_token:
2110+
type: string
2111+
type: object
20372112
ListNetworkPeeringsResponse:
20382113
properties:
20392114
network_peerings:
@@ -4190,6 +4265,19 @@ components:
41904265
- UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
41914266
- UPDATE_CLUSTER_TYPE_SCALING
41924267
type: string
4268+
UpdateGroupBody:
4269+
properties:
4270+
group:
4271+
$ref: '#/components/schemas/GroupUpdate'
4272+
update_mask:
4273+
type: string
4274+
title: UpdateGroupRequest is the request of UpdateGroup
4275+
type: object
4276+
UpdateGroupResponse:
4277+
properties:
4278+
group:
4279+
$ref: '#/components/schemas/Group'
4280+
type: object
41934281
UpdateOrganizationResponse:
41944282
properties:
41954283
organization:
@@ -5545,6 +5633,195 @@ paths:
55455633
summary: Get cluster
55465634
tags:
55475635
- Clusters
5636+
/v1/groups:
5637+
get:
5638+
description: List groups in your organization.
5639+
operationId: GroupService_ListGroups
5640+
parameters:
5641+
- in: query
5642+
name: filter.name
5643+
schema:
5644+
type: string
5645+
- in: query
5646+
name: page_size
5647+
schema:
5648+
format: int32
5649+
type: integer
5650+
- in: query
5651+
name: page_token
5652+
schema:
5653+
type: string
5654+
- in: query
5655+
name: read_mask
5656+
schema:
5657+
type: string
5658+
responses:
5659+
"200":
5660+
content:
5661+
application/json:
5662+
schema:
5663+
$ref: '#/components/schemas/ListGroupsResponse'
5664+
description: OK
5665+
"500":
5666+
content:
5667+
application/json:
5668+
schema:
5669+
$ref: '#/components/schemas/rpc.Status'
5670+
description: Internal Server Error. Reach out to support.
5671+
default:
5672+
content:
5673+
application/json:
5674+
schema:
5675+
$ref: '#/components/schemas/rpc.Status'
5676+
description: An unexpected error response.
5677+
summary: List groups
5678+
tags:
5679+
- Control Plane Groups
5680+
post:
5681+
description: Create a Redpanda Cloud Group.
5682+
operationId: GroupService_CreateGroup
5683+
requestBody:
5684+
content:
5685+
application/json:
5686+
schema:
5687+
$ref: '#/components/schemas/CreateGroupRequest'
5688+
description: CreateGroupRequest is the request of CreateGroup.
5689+
required: true
5690+
x-originalParamName: body
5691+
responses:
5692+
"201":
5693+
content:
5694+
application/json:
5695+
schema:
5696+
$ref: '#/components/schemas/CreateGroupResponse'
5697+
description: Group Created
5698+
"500":
5699+
content:
5700+
application/json:
5701+
schema:
5702+
$ref: '#/components/schemas/rpc.Status'
5703+
description: Internal Server Error. Reach out to support.
5704+
default:
5705+
content:
5706+
application/json:
5707+
schema:
5708+
$ref: '#/components/schemas/rpc.Status'
5709+
description: An unexpected error response.
5710+
summary: Create group
5711+
tags:
5712+
- Control Plane Groups
5713+
/v1/groups/{id}:
5714+
delete:
5715+
description: Delete a group.
5716+
operationId: GroupService_DeleteGroup
5717+
parameters:
5718+
- in: path
5719+
name: id
5720+
required: true
5721+
schema:
5722+
type: string
5723+
responses:
5724+
"204":
5725+
content:
5726+
application/json:
5727+
schema: {}
5728+
description: Group was deleted successfully
5729+
"404":
5730+
content:
5731+
application/json:
5732+
schema:
5733+
$ref: '#/components/schemas/rpc.Status'
5734+
description: Not Found
5735+
default:
5736+
content:
5737+
application/json:
5738+
schema:
5739+
$ref: '#/components/schemas/rpc.Status'
5740+
description: An unexpected error response.
5741+
summary: Delete group
5742+
tags:
5743+
- Control Plane Groups
5744+
get:
5745+
description: Get group details.
5746+
operationId: GroupService_GetGroup
5747+
parameters:
5748+
- in: path
5749+
name: id
5750+
required: true
5751+
schema:
5752+
type: string
5753+
responses:
5754+
"200":
5755+
content:
5756+
application/json:
5757+
schema:
5758+
$ref: '#/components/schemas/GetGroupResponse'
5759+
description: Ok
5760+
"404":
5761+
content:
5762+
application/json:
5763+
schema:
5764+
$ref: '#/components/schemas/rpc.Status'
5765+
description: Not Found
5766+
"500":
5767+
content:
5768+
application/json:
5769+
schema:
5770+
$ref: '#/components/schemas/rpc.Status'
5771+
description: Internal Server Error. Reach out to support.
5772+
default:
5773+
content:
5774+
application/json:
5775+
schema:
5776+
$ref: '#/components/schemas/rpc.Status'
5777+
description: An unexpected error response.
5778+
summary: Get group
5779+
tags:
5780+
- Control Plane Groups
5781+
patch:
5782+
description: Update a Redpanda Cloud group.
5783+
operationId: GroupService_UpdateGroup
5784+
parameters:
5785+
- in: path
5786+
name: id
5787+
required: true
5788+
schema:
5789+
type: string
5790+
requestBody:
5791+
content:
5792+
application/json:
5793+
schema:
5794+
$ref: '#/components/schemas/UpdateGroupBody'
5795+
required: true
5796+
x-originalParamName: body
5797+
responses:
5798+
"200":
5799+
content:
5800+
application/json:
5801+
schema:
5802+
$ref: '#/components/schemas/UpdateGroupResponse'
5803+
description: Ok
5804+
"404":
5805+
content:
5806+
application/json:
5807+
schema:
5808+
$ref: '#/components/schemas/rpc.Status'
5809+
description: Not Found
5810+
"500":
5811+
content:
5812+
application/json:
5813+
schema:
5814+
$ref: '#/components/schemas/rpc.Status'
5815+
description: Internal Server Error. Reach out to support.
5816+
default:
5817+
content:
5818+
application/json:
5819+
schema:
5820+
$ref: '#/components/schemas/rpc.Status'
5821+
description: An unexpected error response.
5822+
summary: Update group
5823+
tags:
5824+
- Control Plane Groups
55485825
/v1/network/{network_id}/network-peerings:
55495826
get:
55505827
description: List Redpanda networks peerings.
@@ -8578,7 +8855,7 @@ tags:
85788855
name: Network Peerings
85798856
- description: Manage [Redpanda Serverless](https://docs.redpanda.com/redpanda-cloud/get-started/cloud-overview/#redpanda-cloud-cluster-types) clusters. For detailed steps, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/).
85808857
name: Serverless Clusters
8581-
- description: 'Manage Redpanda Serverless private links. For detailed steps and information, see [Configure AWS PrivateLink with the Cloud API](https://docs.redpanda.com/redpanda-cloud/networking/serverless/aws/privatelink-api/).'
8858+
- description: 'Manage Redpanda Serverless private links. For detailed steps and information, see [Networking: Serverless](https://docs.redpanda.com/redpanda-cloud/networking/serverless).'
85828859
name: Serverless Private Links
85838860
- description: Get information about available Redpanda regions.
85848861
name: Regions
@@ -8589,6 +8866,8 @@ tags:
85898866
- name: ShadowLinkService
85908867
- description: Manage Redpanda Cloud shadow links for data replication.
85918868
name: Shadow Links
8869+
- description: Manage Redpanda Cloud groups.
8870+
name: Control Plane Groups
85928871
- description: See information about the organization the current user belongs to.
85938872
name: Organization
85948873
- description: Manage your Redpanda Cloud organization permissions.
@@ -8602,4 +8881,4 @@ tags:
86028881
- description: Manage Redpanda Cloud organization users.
86038882
name: Control Plane Users
86048883
- description: Manage user invites for your organization.
8605-
name: User Invites
8884+
name: User Invites

‎cloud-dataplane/cloud-dataplane.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7852,7 +7852,7 @@ paths:
78527852
schema:
78537853
$ref: '#/components/schemas/TransformMetadata'
78547854
description: Created
7855-
summary: Deploy transform
7855+
summary: Deploy Transform
78567856
tags:
78577857
- Wasm Transforms
78587858
/v1/transforms/{name}:

0 commit comments

Comments
 (0)