Skip to content

Commit 35655e4

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

2 files changed

Lines changed: 285 additions & 4 deletions

File tree

‎cloud-controlplane/cloud-controlplane.yaml‎

Lines changed: 283 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:
@@ -3256,6 +3331,7 @@ components:
32563331
- SCOPE_RESOURCE_TYPE_AIGATEWAY_MODEL
32573332
- SCOPE_RESOURCE_TYPE_AIGATEWAY_PROVIDER_CONFIG
32583333
- SCOPE_RESOURCE_TYPE_AIGATEWAY_GATEWAY
3334+
- SCOPE_RESOURCE_TYPE_KAFKA_TOPIC
32593335
type: string
32603336
ScramConfig:
32613337
properties:
@@ -4190,6 +4266,19 @@ components:
41904266
- UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
41914267
- UPDATE_CLUSTER_TYPE_SCALING
41924268
type: string
4269+
UpdateGroupBody:
4270+
properties:
4271+
group:
4272+
$ref: '#/components/schemas/GroupUpdate'
4273+
update_mask:
4274+
type: string
4275+
title: UpdateGroupRequest is the request of UpdateGroup
4276+
type: object
4277+
UpdateGroupResponse:
4278+
properties:
4279+
group:
4280+
$ref: '#/components/schemas/Group'
4281+
type: object
41934282
UpdateOrganizationResponse:
41944283
properties:
41954284
organization:
@@ -5545,6 +5634,195 @@ paths:
55455634
summary: Get cluster
55465635
tags:
55475636
- Clusters
5637+
/v1/groups:
5638+
get:
5639+
description: List groups in your organization.
5640+
operationId: GroupService_ListGroups
5641+
parameters:
5642+
- in: query
5643+
name: filter.name
5644+
schema:
5645+
type: string
5646+
- in: query
5647+
name: page_size
5648+
schema:
5649+
format: int32
5650+
type: integer
5651+
- in: query
5652+
name: page_token
5653+
schema:
5654+
type: string
5655+
- in: query
5656+
name: read_mask
5657+
schema:
5658+
type: string
5659+
responses:
5660+
"200":
5661+
content:
5662+
application/json:
5663+
schema:
5664+
$ref: '#/components/schemas/ListGroupsResponse'
5665+
description: OK
5666+
"500":
5667+
content:
5668+
application/json:
5669+
schema:
5670+
$ref: '#/components/schemas/rpc.Status'
5671+
description: Internal Server Error. Reach out to support.
5672+
default:
5673+
content:
5674+
application/json:
5675+
schema:
5676+
$ref: '#/components/schemas/rpc.Status'
5677+
description: An unexpected error response.
5678+
summary: List groups
5679+
tags:
5680+
- Control Plane Groups
5681+
post:
5682+
description: Create a Redpanda Cloud Group.
5683+
operationId: GroupService_CreateGroup
5684+
requestBody:
5685+
content:
5686+
application/json:
5687+
schema:
5688+
$ref: '#/components/schemas/CreateGroupRequest'
5689+
description: CreateGroupRequest is the request of CreateGroup.
5690+
required: true
5691+
x-originalParamName: body
5692+
responses:
5693+
"201":
5694+
content:
5695+
application/json:
5696+
schema:
5697+
$ref: '#/components/schemas/CreateGroupResponse'
5698+
description: Group Created
5699+
"500":
5700+
content:
5701+
application/json:
5702+
schema:
5703+
$ref: '#/components/schemas/rpc.Status'
5704+
description: Internal Server Error. Reach out to support.
5705+
default:
5706+
content:
5707+
application/json:
5708+
schema:
5709+
$ref: '#/components/schemas/rpc.Status'
5710+
description: An unexpected error response.
5711+
summary: Create group
5712+
tags:
5713+
- Control Plane Groups
5714+
/v1/groups/{id}:
5715+
delete:
5716+
description: Delete a group.
5717+
operationId: GroupService_DeleteGroup
5718+
parameters:
5719+
- in: path
5720+
name: id
5721+
required: true
5722+
schema:
5723+
type: string
5724+
responses:
5725+
"204":
5726+
content:
5727+
application/json:
5728+
schema: {}
5729+
description: Group was deleted successfully
5730+
"404":
5731+
content:
5732+
application/json:
5733+
schema:
5734+
$ref: '#/components/schemas/rpc.Status'
5735+
description: Not Found
5736+
default:
5737+
content:
5738+
application/json:
5739+
schema:
5740+
$ref: '#/components/schemas/rpc.Status'
5741+
description: An unexpected error response.
5742+
summary: Delete group
5743+
tags:
5744+
- Control Plane Groups
5745+
get:
5746+
description: Get group details.
5747+
operationId: GroupService_GetGroup
5748+
parameters:
5749+
- in: path
5750+
name: id
5751+
required: true
5752+
schema:
5753+
type: string
5754+
responses:
5755+
"200":
5756+
content:
5757+
application/json:
5758+
schema:
5759+
$ref: '#/components/schemas/GetGroupResponse'
5760+
description: Ok
5761+
"404":
5762+
content:
5763+
application/json:
5764+
schema:
5765+
$ref: '#/components/schemas/rpc.Status'
5766+
description: Not Found
5767+
"500":
5768+
content:
5769+
application/json:
5770+
schema:
5771+
$ref: '#/components/schemas/rpc.Status'
5772+
description: Internal Server Error. Reach out to support.
5773+
default:
5774+
content:
5775+
application/json:
5776+
schema:
5777+
$ref: '#/components/schemas/rpc.Status'
5778+
description: An unexpected error response.
5779+
summary: Get group
5780+
tags:
5781+
- Control Plane Groups
5782+
patch:
5783+
description: Update a Redpanda Cloud group.
5784+
operationId: GroupService_UpdateGroup
5785+
parameters:
5786+
- in: path
5787+
name: id
5788+
required: true
5789+
schema:
5790+
type: string
5791+
requestBody:
5792+
content:
5793+
application/json:
5794+
schema:
5795+
$ref: '#/components/schemas/UpdateGroupBody'
5796+
required: true
5797+
x-originalParamName: body
5798+
responses:
5799+
"200":
5800+
content:
5801+
application/json:
5802+
schema:
5803+
$ref: '#/components/schemas/UpdateGroupResponse'
5804+
description: Ok
5805+
"404":
5806+
content:
5807+
application/json:
5808+
schema:
5809+
$ref: '#/components/schemas/rpc.Status'
5810+
description: Not Found
5811+
"500":
5812+
content:
5813+
application/json:
5814+
schema:
5815+
$ref: '#/components/schemas/rpc.Status'
5816+
description: Internal Server Error. Reach out to support.
5817+
default:
5818+
content:
5819+
application/json:
5820+
schema:
5821+
$ref: '#/components/schemas/rpc.Status'
5822+
description: An unexpected error response.
5823+
summary: Update group
5824+
tags:
5825+
- Control Plane Groups
55485826
/v1/network/{network_id}/network-peerings:
55495827
get:
55505828
description: List Redpanda networks peerings.
@@ -6750,6 +7028,7 @@ paths:
67507028
- SCOPE_RESOURCE_TYPE_AIGATEWAY_MODEL
67517029
- SCOPE_RESOURCE_TYPE_AIGATEWAY_PROVIDER_CONFIG
67527030
- SCOPE_RESOURCE_TYPE_AIGATEWAY_GATEWAY
7031+
- SCOPE_RESOURCE_TYPE_KAFKA_TOPIC
67537032
type: string
67547033
- in: query
67557034
name: filter.scope.resource_id
@@ -8578,7 +8857,7 @@ tags:
85788857
name: Network Peerings
85798858
- 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/).
85808859
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/).'
8860+
- description: 'Manage Redpanda Serverless private links. For detailed steps and information, see [Networking: Serverless](https://docs.redpanda.com/redpanda-cloud/networking/serverless).'
85828861
name: Serverless Private Links
85838862
- description: Get information about available Redpanda regions.
85848863
name: Regions
@@ -8589,6 +8868,8 @@ tags:
85898868
- name: ShadowLinkService
85908869
- description: Manage Redpanda Cloud shadow links for data replication.
85918870
name: Shadow Links
8871+
- description: Manage Redpanda Cloud groups.
8872+
name: Control Plane Groups
85928873
- description: See information about the organization the current user belongs to.
85938874
name: Organization
85948875
- description: Manage your Redpanda Cloud organization permissions.
@@ -8602,4 +8883,4 @@ tags:
86028883
- description: Manage Redpanda Cloud organization users.
86038884
name: Control Plane Users
86048885
- description: Manage user invites for your organization.
8605-
name: User Invites
8886+
name: User Invites

‎cloud-dataplane/cloud-dataplane.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7834,7 +7834,7 @@ paths:
78347834
content:
78357835
multipart/form-data:
78367836
schema:
7837-
example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
7837+
example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
78387838
properties:
78397839
metadata:
78407840
$ref: '#/components/schemas/DeployTransformRequest'
@@ -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)