Skip to content

Commit c7b1b80

Browse files
fix(kafka-mgmt/v1): update kafka-mgmt/v1 SDK (#381)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent e359a9b commit c7b1b80

17 files changed

Lines changed: 1328 additions & 119 deletions

.openapi/kas-fleet-manager.yaml

Lines changed: 89 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -899,6 +899,56 @@ paths:
899899
parameters:
900900
- $ref: "#/components/parameters/id"
901901
/api/kafkas_mgmt/v1/clusters:
902+
get:
903+
tags:
904+
- enterprise-dataplane-clusters
905+
description: List all Enterprise OSD clusters
906+
operationId: getEnterpriseOsdClusters
907+
security:
908+
- Bearer: [ ]
909+
responses:
910+
"200":
911+
description: List Enterprise OSD clusters
912+
content:
913+
application/json:
914+
schema:
915+
$ref: '#/components/schemas/EnterpriseClusterList'
916+
"400":
917+
description: Bad request
918+
content:
919+
application/json:
920+
schema:
921+
$ref: '#/components/schemas/Error'
922+
examples:
923+
InvalidQueryExample:
924+
$ref: '#/components/examples/400InvalidQueryExample'
925+
"401":
926+
description: Auth token is invalid
927+
content:
928+
application/json:
929+
schema:
930+
$ref: '#/components/schemas/Error'
931+
examples:
932+
401Example:
933+
$ref: '#/components/examples/401Example'
934+
"403":
935+
content:
936+
application/json:
937+
schema:
938+
$ref: '#/components/schemas/Error'
939+
examples:
940+
403Example:
941+
$ref: '#/components/examples/403Example'
942+
description: User not authorized to access the service
943+
"500":
944+
description: Unexpected error occurred
945+
content:
946+
application/json:
947+
schema:
948+
$ref: '#/components/schemas/Error'
949+
examples:
950+
500Example:
951+
$ref: '#/components/examples/500Example'
902952
post:
903953
description: Register enterprise data plane cluster
904954
operationId: registerEnterpriseOsdCluster
@@ -917,7 +967,7 @@ paths:
917967
content:
918968
application/json:
919969
schema:
920-
$ref: '#/components/schemas/EnterpriseCluster'
970+
$ref: '#/components/schemas/EnterpriseClusterRegistrationResponse'
921971
description: Enterprise cluster registered
922972
"400":
923973
content:
@@ -1144,6 +1194,35 @@ components:
11441194
items:
11451195
allOf:
11461196
- $ref: "#/components/schemas/KafkaRequest"
1197+
EnterpriseClusterList:
1198+
allOf:
1199+
- $ref: "#/components/schemas/List"
1200+
- type: object
1201+
example:
1202+
kind: "ClusterList"
1203+
page: "1"
1204+
size: "1"
1205+
total: "1"
1206+
item:
1207+
$ref: '#/components/examples/EnterpriseClusterExample'
1208+
properties:
1209+
items:
1210+
type: array
1211+
items:
1212+
allOf:
1213+
- $ref: "#/components/schemas/EnterpriseCluster"
1214+
EnterpriseCluster:
1215+
allOf:
1216+
- $ref: "#/components/schemas/ObjectReference"
1217+
- type: object
1218+
properties:
1219+
cluster_id:
1220+
type: string
1221+
description: 'ocm cluster id of the registered Enterprise cluster'
1222+
status:
1223+
description: 'status of registered Enterprise cluster'
1224+
type: string
1225+
11471226
VersionMetadata:
11481227
allOf:
11491228
- $ref: "#/components/schemas/ObjectReference"
@@ -1650,9 +1729,10 @@ components:
16501729
The node count value has to be a multiple of 3 with a minimum of 3 nodes.
16511730
type: integer
16521731
format: int32
1653-
EnterpriseCluster:
1732+
EnterpriseClusterRegistrationResponse:
16541733
description: Enterprise cluster registration endpoint response
16551734
allOf:
1735+
- $ref: "#/components/schemas/ObjectReference"
16561736
- type: object
16571737
properties:
16581738
cluster_id:
@@ -1853,6 +1933,13 @@ components:
18531933
cloud_provider: "aws"
18541934
name: "test_kafka"
18551935
plan: "standard.x1"
1936+
EnterpriseClusterExample:
1937+
value:
1938+
id: "abcd1234ascd3456fdks9485lskd030h"
1939+
kind: "cluster"
1940+
href: "/api/kafkas_mgmr/v1/clusters/abcd1234ascd3456fdks9485lskd030h"
1941+
status: "ready"
1942+
cluster_id: "abcd1234ascd3456fdks9485lskd030h"
18561943
KafkaRequestExample:
18571944
value:
18581945
id: "1iSY6RQ3JKI8Q0OTmjQFd3ocFRg"

packages/kafka-management-sdk/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
130130
*DefaultApi* | [**getMetricsByRangeQuery**](docs/DefaultApi.md#getMetricsByRangeQuery) | **GET** /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query_range |
131131
*DefaultApi* | [**getVersionMetadata**](docs/DefaultApi.md#getVersionMetadata) | **GET** /api/kafkas_mgmt/v1 |
132132
*DefaultApi* | [**updateKafkaById**](docs/DefaultApi.md#updateKafkaById) | **PATCH** /api/kafkas_mgmt/v1/kafkas/{id} |
133+
*EnterpriseDataplaneClustersApi* | [**getEnterpriseOsdClusters**](docs/EnterpriseDataplaneClustersApi.md#getEnterpriseOsdClusters) | **GET** /api/kafkas_mgmt/v1/clusters |
133134
*EnterpriseDataplaneClustersApi* | [**registerEnterpriseOsdCluster**](docs/EnterpriseDataplaneClustersApi.md#registerEnterpriseOsdCluster) | **POST** /api/kafkas_mgmt/v1/clusters |
134135
*ErrorsApi* | [**getErrorById**](docs/ErrorsApi.md#getErrorById) | **GET** /api/kafkas_mgmt/v1/errors/{id} |
135136
*ErrorsApi* | [**getErrors**](docs/ErrorsApi.md#getErrors) | **GET** /api/kafkas_mgmt/v1/errors |
@@ -151,6 +152,10 @@ Class | Method | HTTP request | Description
151152
- [CloudRegionListAllOf](docs/CloudRegionListAllOf.md)
152153
- [EnterpriseCluster](docs/EnterpriseCluster.md)
153154
- [EnterpriseClusterAllOf](docs/EnterpriseClusterAllOf.md)
155+
- [EnterpriseClusterList](docs/EnterpriseClusterList.md)
156+
- [EnterpriseClusterListAllOf](docs/EnterpriseClusterListAllOf.md)
157+
- [EnterpriseClusterRegistrationResponse](docs/EnterpriseClusterRegistrationResponse.md)
158+
- [EnterpriseClusterRegistrationResponseAllOf](docs/EnterpriseClusterRegistrationResponseAllOf.md)
154159
- [EnterpriseOsdClusterPayload](docs/EnterpriseOsdClusterPayload.md)
155160
- [Error](docs/Error.md)
156161
- [ErrorList](docs/ErrorList.md)

packages/kafka-management-sdk/api/openapi.yaml

Lines changed: 95 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1202,6 +1202,57 @@ paths:
12021202
- Bearer: []
12031203
x-accepts: application/json
12041204
/api/kafkas_mgmt/v1/clusters:
1205+
get:
1206+
description: List all Enterprise OSD clusters
1207+
operationId: getEnterpriseOsdClusters
1208+
responses:
1209+
"200":
1210+
content:
1211+
application/json:
1212+
schema:
1213+
$ref: '#/components/schemas/EnterpriseClusterList'
1214+
description: List Enterprise OSD clusters
1215+
"400":
1216+
content:
1217+
application/json:
1218+
examples:
1219+
InvalidQueryExample:
1220+
$ref: '#/components/examples/400InvalidQueryExample'
1221+
schema:
1222+
$ref: '#/components/schemas/Error'
1223+
description: Bad request
1224+
"401":
1225+
content:
1226+
application/json:
1227+
examples:
1228+
"401Example":
1229+
$ref: '#/components/examples/401Example'
1230+
schema:
1231+
$ref: '#/components/schemas/Error'
1232+
description: Auth token is invalid
1233+
"403":
1234+
content:
1235+
application/json:
1236+
examples:
1237+
"403Example":
1238+
$ref: '#/components/examples/403Example'
1239+
schema:
1240+
$ref: '#/components/schemas/Error'
1241+
description: User not authorized to access the service
1242+
"500":
1243+
content:
1244+
application/json:
1245+
examples:
1246+
"500Example":
1247+
$ref: '#/components/examples/500Example'
1248+
schema:
1249+
$ref: '#/components/schemas/Error'
1250+
description: Unexpected error occurred
1251+
security:
1252+
- Bearer: []
1253+
tags:
1254+
- enterprise-dataplane-clusters
1255+
x-accepts: application/json
12051256
post:
12061257
description: Register enterprise data plane cluster
12071258
operationId: registerEnterpriseOsdCluster
@@ -1220,7 +1271,7 @@ paths:
12201271
content:
12211272
application/json:
12221273
schema:
1223-
$ref: '#/components/schemas/EnterpriseCluster'
1274+
$ref: '#/components/schemas/EnterpriseClusterRegistrationResponse'
12241275
description: Enterprise cluster registered
12251276
"400":
12261277
content:
@@ -1293,6 +1344,13 @@ components:
12931344
cloud_provider: aws
12941345
name: test_kafka
12951346
plan: standard.x1
1347+
EnterpriseClusterExample:
1348+
value:
1349+
id: abcd1234ascd3456fdks9485lskd030h
1350+
kind: cluster
1351+
href: /api/kafkas_mgmr/v1/clusters/abcd1234ascd3456fdks9485lskd030h
1352+
status: ready
1353+
cluster_id: abcd1234ascd3456fdks9485lskd030h
12961354
KafkaRequestExample:
12971355
value:
12981356
id: 1iSY6RQ3JKI8Q0OTmjQFd3ocFRg
@@ -1868,6 +1926,14 @@ components:
18681926
allOf:
18691927
- $ref: '#/components/schemas/List'
18701928
- $ref: '#/components/schemas/KafkaRequestList_allOf'
1929+
EnterpriseClusterList:
1930+
allOf:
1931+
- $ref: '#/components/schemas/List'
1932+
- $ref: '#/components/schemas/EnterpriseClusterList_allOf'
1933+
EnterpriseCluster:
1934+
allOf:
1935+
- $ref: '#/components/schemas/ObjectReference'
1936+
- $ref: '#/components/schemas/EnterpriseCluster_allOf'
18711937
VersionMetadata:
18721938
allOf:
18731939
- $ref: '#/components/schemas/ObjectReference'
@@ -2241,9 +2307,10 @@ components:
22412307
- cluster_ingress_dns_name
22422308
- kafka_machine_pool_node_count
22432309
type: object
2244-
EnterpriseCluster:
2310+
EnterpriseClusterRegistrationResponse:
22452311
allOf:
2246-
- $ref: '#/components/schemas/EnterpriseCluster_allOf'
2312+
- $ref: '#/components/schemas/ObjectReference'
2313+
- $ref: '#/components/schemas/EnterpriseClusterRegistrationResponse_allOf'
22472314
description: Enterprise cluster registration endpoint response
22482315
FleetshardParameter:
22492316
description: Fleetshard parameter consumed by enterprise cluster
@@ -2337,6 +2404,30 @@ components:
23372404
- $ref: '#/components/schemas/KafkaRequest'
23382405
type: array
23392406
type: object
2407+
EnterpriseClusterList_allOf:
2408+
example:
2409+
kind: ClusterList
2410+
page: "1"
2411+
size: "1"
2412+
total: "1"
2413+
item:
2414+
$ref: '#/components/examples/EnterpriseClusterExample'
2415+
properties:
2416+
items:
2417+
items:
2418+
allOf:
2419+
- $ref: '#/components/schemas/EnterpriseCluster'
2420+
type: array
2421+
type: object
2422+
EnterpriseCluster_allOf:
2423+
properties:
2424+
cluster_id:
2425+
description: ocm cluster id of the registered Enterprise cluster
2426+
type: string
2427+
status:
2428+
description: status of registered Enterprise cluster
2429+
type: string
2430+
type: object
23402431
VersionMetadata_allOf:
23412432
example:
23422433
kind: APIVersion
@@ -2508,7 +2599,7 @@ components:
25082599
- $ref: '#/components/schemas/InstantQuery'
25092600
type: array
25102601
type: object
2511-
EnterpriseCluster_allOf:
2602+
EnterpriseClusterRegistrationResponse_allOf:
25122603
properties:
25132604
cluster_id:
25142605
description: OCM cluster id of the registered Enterprise cluster

packages/kafka-management-sdk/docs/EnterpriseCluster.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
# EnterpriseCluster
44

5-
Enterprise cluster registration endpoint response
65

76
## Properties
87

98
Name | Type | Description | Notes
109
------------ | ------------- | ------------- | -------------
11-
**clusterId** | **String** | OCM cluster id of the registered Enterprise cluster | [optional]
10+
**id** | **String** | |
11+
**kind** | **String** | |
12+
**href** | **String** | |
13+
**clusterId** | **String** | ocm cluster id of the registered Enterprise cluster | [optional]
1214
**status** | **String** | status of registered Enterprise cluster | [optional]
13-
**fleetshardParameters** | [**List&lt;FleetshardParameter&gt;**](FleetshardParameter.md) | | [optional]
1415

1516

1617

packages/kafka-management-sdk/docs/EnterpriseClusterAllOf.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77

88
Name | Type | Description | Notes
99
------------ | ------------- | ------------- | -------------
10-
**clusterId** | **String** | OCM cluster id of the registered Enterprise cluster | [optional]
10+
**clusterId** | **String** | ocm cluster id of the registered Enterprise cluster | [optional]
1111
**status** | **String** | status of registered Enterprise cluster | [optional]
12-
**fleetshardParameters** | [**List&lt;FleetshardParameter&gt;**](FleetshardParameter.md) | | [optional]
1312

1413

1514

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
# EnterpriseClusterList
4+
5+
6+
## Properties
7+
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**kind** | **String** | |
11+
**page** | **Integer** | |
12+
**size** | **Integer** | |
13+
**total** | **Integer** | |
14+
**items** | [**List&lt;EnterpriseCluster&gt;**](EnterpriseCluster.md) | |
15+
16+
17+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# EnterpriseClusterListAllOf
4+
5+
6+
## Properties
7+
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**items** | [**List&lt;EnterpriseCluster&gt;**](EnterpriseCluster.md) | | [optional]
11+
12+
13+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
3+
# EnterpriseClusterRegistrationResponse
4+
5+
Enterprise cluster registration endpoint response
6+
7+
## Properties
8+
9+
Name | Type | Description | Notes
10+
------------ | ------------- | ------------- | -------------
11+
**id** | **String** | |
12+
**kind** | **String** | |
13+
**href** | **String** | |
14+
**clusterId** | **String** | OCM cluster id of the registered Enterprise cluster | [optional]
15+
**status** | **String** | status of registered Enterprise cluster | [optional]
16+
**fleetshardParameters** | [**List&lt;FleetshardParameter&gt;**](FleetshardParameter.md) | | [optional]
17+
18+
19+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# EnterpriseClusterRegistrationResponseAllOf
4+
5+
6+
## Properties
7+
8+
Name | Type | Description | Notes
9+
------------ | ------------- | ------------- | -------------
10+
**clusterId** | **String** | OCM cluster id of the registered Enterprise cluster | [optional]
11+
**status** | **String** | status of registered Enterprise cluster | [optional]
12+
**fleetshardParameters** | [**List&lt;FleetshardParameter&gt;**](FleetshardParameter.md) | | [optional]
13+
14+
15+

0 commit comments

Comments
 (0)