Skip to content

Commit 7d8dee5

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

2 files changed

Lines changed: 296 additions & 4 deletions

File tree

‎cloud-controlplane/cloud-controlplane.yaml‎

Lines changed: 294 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:
@@ -1348,6 +1359,10 @@ components:
13481359
CustomerManagedResourcesUpdate.AWS:
13491360
description: AWS resources managed by user.
13501361
properties:
1362+
oxla_node_group_instance_profile:
1363+
$ref: '#/components/schemas/AWSInstanceProfile'
1364+
oxla_security_group:
1365+
$ref: '#/components/schemas/AWSSecurityGroup'
13511366
redpanda_connect_node_group_instance_profile:
13521367
$ref: '#/components/schemas/AWSInstanceProfile'
13531368
redpanda_connect_security_group:
@@ -1430,6 +1445,8 @@ components:
14301445
DeleteClusterResponse:
14311446
description: DeleteClusterResponse is the request of DeleteCluster.
14321447
type: object
1448+
DeleteGroupResponse:
1449+
type: object
14331450
DeleteNetworkMetadata:
14341451
description: Resource describing an in-progress DeleteNetwork Operation.
14351452
title: DeleteNetworkMetadata
@@ -1801,6 +1818,11 @@ components:
18011818
GetCurrentOrganizationResponse the response of the the
18021819
GetCurrentOrganization rpc
18031820
type: object
1821+
GetGroupResponse:
1822+
properties:
1823+
group:
1824+
$ref: '#/components/schemas/Group'
1825+
type: object
18041826
GetNetworkPeeringRequest:
18051827
properties:
18061828
id:
@@ -1894,6 +1916,46 @@ components:
18941916
user:
18951917
$ref: '#/components/schemas/User'
18961918
type: object
1919+
Group:
1920+
properties:
1921+
created_at:
1922+
format: date-time
1923+
type: string
1924+
description:
1925+
description: The description of the group.
1926+
example: Engineering team group for RBAC.
1927+
type: string
1928+
id:
1929+
type: string
1930+
name:
1931+
description: The unique name of the group.
1932+
example: engineering
1933+
type: string
1934+
type: object
1935+
GroupCreate:
1936+
properties:
1937+
description:
1938+
description: The description of the group.
1939+
example: Engineering team group for RBAC.
1940+
nullable: true
1941+
type: string
1942+
name:
1943+
description: The unique name of the group.
1944+
example: engineering
1945+
type: string
1946+
type: object
1947+
GroupUpdate:
1948+
properties:
1949+
description:
1950+
description: The description of the group.
1951+
example: Engineering team group for RBAC.
1952+
nullable: true
1953+
type: string
1954+
name:
1955+
description: The unique name of the group.
1956+
example: engineering
1957+
type: string
1958+
type: object
18971959
HTTPProxySpec:
18981960
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.
18991961
properties:
@@ -2034,6 +2096,23 @@ components:
20342096
description: Page token to fetch the next page. The value can be used as `next_page_token` in the next call to this endpoint.
20352097
type: string
20362098
type: object
2099+
ListGroupsRequest.Filter:
2100+
properties:
2101+
name:
2102+
type: string
2103+
type: object
2104+
ListGroupsResponse:
2105+
description: ListGroupsResponse is the response of ListGroups.
2106+
properties:
2107+
groups:
2108+
description: Groups matching the request
2109+
items:
2110+
$ref: '#/components/schemas/Group'
2111+
maxItems: 100
2112+
type: array
2113+
next_page_token:
2114+
type: string
2115+
type: object
20372116
ListNetworkPeeringsResponse:
20382117
properties:
20392118
network_peerings:
@@ -2852,6 +2931,9 @@ components:
28522931
type: string
28532932
Permission:
28542933
properties:
2934+
description:
2935+
description: A human-readable description of what the permission grants.
2936+
type: string
28552937
name:
28562938
type: string
28572939
type: object
@@ -3256,6 +3338,7 @@ components:
32563338
- SCOPE_RESOURCE_TYPE_AIGATEWAY_MODEL
32573339
- SCOPE_RESOURCE_TYPE_AIGATEWAY_PROVIDER_CONFIG
32583340
- SCOPE_RESOURCE_TYPE_AIGATEWAY_GATEWAY
3341+
- SCOPE_RESOURCE_TYPE_KAFKA_TOPIC
32593342
type: string
32603343
ScramConfig:
32613344
properties:
@@ -4190,6 +4273,19 @@ components:
41904273
- UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG
41914274
- UPDATE_CLUSTER_TYPE_SCALING
41924275
type: string
4276+
UpdateGroupBody:
4277+
properties:
4278+
group:
4279+
$ref: '#/components/schemas/GroupUpdate'
4280+
update_mask:
4281+
type: string
4282+
title: UpdateGroupRequest is the request of UpdateGroup
4283+
type: object
4284+
UpdateGroupResponse:
4285+
properties:
4286+
group:
4287+
$ref: '#/components/schemas/Group'
4288+
type: object
41934289
UpdateOrganizationResponse:
41944290
properties:
41954291
organization:
@@ -4598,6 +4694,10 @@ components:
45984694
$ref: '#/components/schemas/AWS.Role'
45994695
node_security_group:
46004696
$ref: '#/components/schemas/AWSSecurityGroup'
4697+
oxla_node_group_instance_profile:
4698+
$ref: '#/components/schemas/AWSInstanceProfile'
4699+
oxla_security_group:
4700+
$ref: '#/components/schemas/AWSSecurityGroup'
46014701
permissions_boundary_policy:
46024702
$ref: '#/components/schemas/Policy'
46034703
redpanda_agent_security_group:
@@ -5545,6 +5645,195 @@ paths:
55455645
summary: Get cluster
55465646
tags:
55475647
- Clusters
5648+
/v1/groups:
5649+
get:
5650+
description: List groups in your organization.
5651+
operationId: GroupService_ListGroups
5652+
parameters:
5653+
- in: query
5654+
name: filter.name
5655+
schema:
5656+
type: string
5657+
- in: query
5658+
name: page_size
5659+
schema:
5660+
format: int32
5661+
type: integer
5662+
- in: query
5663+
name: page_token
5664+
schema:
5665+
type: string
5666+
- in: query
5667+
name: read_mask
5668+
schema:
5669+
type: string
5670+
responses:
5671+
"200":
5672+
content:
5673+
application/json:
5674+
schema:
5675+
$ref: '#/components/schemas/ListGroupsResponse'
5676+
description: OK
5677+
"500":
5678+
content:
5679+
application/json:
5680+
schema:
5681+
$ref: '#/components/schemas/rpc.Status'
5682+
description: Internal Server Error. Reach out to support.
5683+
default:
5684+
content:
5685+
application/json:
5686+
schema:
5687+
$ref: '#/components/schemas/rpc.Status'
5688+
description: An unexpected error response.
5689+
summary: List groups
5690+
tags:
5691+
- Control Plane Groups
5692+
post:
5693+
description: Create a Redpanda Cloud Group.
5694+
operationId: GroupService_CreateGroup
5695+
requestBody:
5696+
content:
5697+
application/json:
5698+
schema:
5699+
$ref: '#/components/schemas/CreateGroupRequest'
5700+
description: CreateGroupRequest is the request of CreateGroup.
5701+
required: true
5702+
x-originalParamName: body
5703+
responses:
5704+
"201":
5705+
content:
5706+
application/json:
5707+
schema:
5708+
$ref: '#/components/schemas/CreateGroupResponse'
5709+
description: Group Created
5710+
"500":
5711+
content:
5712+
application/json:
5713+
schema:
5714+
$ref: '#/components/schemas/rpc.Status'
5715+
description: Internal Server Error. Reach out to support.
5716+
default:
5717+
content:
5718+
application/json:
5719+
schema:
5720+
$ref: '#/components/schemas/rpc.Status'
5721+
description: An unexpected error response.
5722+
summary: Create group
5723+
tags:
5724+
- Control Plane Groups
5725+
/v1/groups/{id}:
5726+
delete:
5727+
description: Delete a group.
5728+
operationId: GroupService_DeleteGroup
5729+
parameters:
5730+
- in: path
5731+
name: id
5732+
required: true
5733+
schema:
5734+
type: string
5735+
responses:
5736+
"204":
5737+
content:
5738+
application/json:
5739+
schema: {}
5740+
description: Group was deleted successfully
5741+
"404":
5742+
content:
5743+
application/json:
5744+
schema:
5745+
$ref: '#/components/schemas/rpc.Status'
5746+
description: Not Found
5747+
default:
5748+
content:
5749+
application/json:
5750+
schema:
5751+
$ref: '#/components/schemas/rpc.Status'
5752+
description: An unexpected error response.
5753+
summary: Delete group
5754+
tags:
5755+
- Control Plane Groups
5756+
get:
5757+
description: Get group details.
5758+
operationId: GroupService_GetGroup
5759+
parameters:
5760+
- in: path
5761+
name: id
5762+
required: true
5763+
schema:
5764+
type: string
5765+
responses:
5766+
"200":
5767+
content:
5768+
application/json:
5769+
schema:
5770+
$ref: '#/components/schemas/GetGroupResponse'
5771+
description: Ok
5772+
"404":
5773+
content:
5774+
application/json:
5775+
schema:
5776+
$ref: '#/components/schemas/rpc.Status'
5777+
description: Not Found
5778+
"500":
5779+
content:
5780+
application/json:
5781+
schema:
5782+
$ref: '#/components/schemas/rpc.Status'
5783+
description: Internal Server Error. Reach out to support.
5784+
default:
5785+
content:
5786+
application/json:
5787+
schema:
5788+
$ref: '#/components/schemas/rpc.Status'
5789+
description: An unexpected error response.
5790+
summary: Get group
5791+
tags:
5792+
- Control Plane Groups
5793+
patch:
5794+
description: Update a Redpanda Cloud group.
5795+
operationId: GroupService_UpdateGroup
5796+
parameters:
5797+
- in: path
5798+
name: id
5799+
required: true
5800+
schema:
5801+
type: string
5802+
requestBody:
5803+
content:
5804+
application/json:
5805+
schema:
5806+
$ref: '#/components/schemas/UpdateGroupBody'
5807+
required: true
5808+
x-originalParamName: body
5809+
responses:
5810+
"200":
5811+
content:
5812+
application/json:
5813+
schema:
5814+
$ref: '#/components/schemas/UpdateGroupResponse'
5815+
description: Ok
5816+
"404":
5817+
content:
5818+
application/json:
5819+
schema:
5820+
$ref: '#/components/schemas/rpc.Status'
5821+
description: Not Found
5822+
"500":
5823+
content:
5824+
application/json:
5825+
schema:
5826+
$ref: '#/components/schemas/rpc.Status'
5827+
description: Internal Server Error. Reach out to support.
5828+
default:
5829+
content:
5830+
application/json:
5831+
schema:
5832+
$ref: '#/components/schemas/rpc.Status'
5833+
description: An unexpected error response.
5834+
summary: Update group
5835+
tags:
5836+
- Control Plane Groups
55485837
/v1/network/{network_id}/network-peerings:
55495838
get:
55505839
description: List Redpanda networks peerings.
@@ -6750,6 +7039,7 @@ paths:
67507039
- SCOPE_RESOURCE_TYPE_AIGATEWAY_MODEL
67517040
- SCOPE_RESOURCE_TYPE_AIGATEWAY_PROVIDER_CONFIG
67527041
- SCOPE_RESOURCE_TYPE_AIGATEWAY_GATEWAY
7042+
- SCOPE_RESOURCE_TYPE_KAFKA_TOPIC
67537043
type: string
67547044
- in: query
67557045
name: filter.scope.resource_id
@@ -8578,7 +8868,7 @@ tags:
85788868
name: Network Peerings
85798869
- 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/).
85808870
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/).'
8871+
- description: 'Manage Redpanda Serverless private links. For detailed steps and information, see [Networking: Serverless](https://docs.redpanda.com/redpanda-cloud/networking/serverless).'
85828872
name: Serverless Private Links
85838873
- description: Get information about available Redpanda regions.
85848874
name: Regions
@@ -8589,6 +8879,8 @@ tags:
85898879
- name: ShadowLinkService
85908880
- description: Manage Redpanda Cloud shadow links for data replication.
85918881
name: Shadow Links
8882+
- description: Manage Redpanda Cloud groups.
8883+
name: Control Plane Groups
85928884
- description: See information about the organization the current user belongs to.
85938885
name: Organization
85948886
- description: Manage your Redpanda Cloud organization permissions.
@@ -8602,4 +8894,4 @@ tags:
86028894
- description: Manage Redpanda Cloud organization users.
86038895
name: Control Plane Users
86048896
- description: Manage user invites for your organization.
8605-
name: User Invites
8897+
name: User Invites

0 commit comments

Comments
 (0)