@@ -1180,15 +1180,15 @@ paths:
11801180 - Bearer : []
11811181 /api/kafkas_mgmt/v1/clusters :
11821182 get :
1183- description : List all Enterprise OSD clusters
1183+ description : List all Enterprise data plane clusters
11841184 operationId : getEnterpriseOsdClusters
11851185 responses :
11861186 " 200 " :
11871187 content :
11881188 application/json :
11891189 schema :
11901190 $ref : ' #/components/schemas/EnterpriseClusterList'
1191- description : List Enterprise OSD clusters
1191+ description : List Enterprise data plane clusters
11921192 " 400 " :
11931193 content :
11941194 application/json :
@@ -1255,8 +1255,8 @@ paths:
12551255 examples :
12561256 " 400InvalidClusterIdExample " :
12571257 $ref : ' #/components/examples/400InvalidClusterIdExample'
1258- " 400MInvalidExternalClusterIdExample " :
1259- $ref : ' #/components/examples/400MInvalidExternalClusterIdExample '
1258+ " 400InvalidExternalClusterIdExample " :
1259+ $ref : ' #/components/examples/400InvalidExternalClusterIdExample '
12601260 schema :
12611261 $ref : ' #/components/schemas/Error'
12621262 description : Validation errors occurred
@@ -1300,6 +1300,92 @@ paths:
13001300 - Bearer : []
13011301 tags :
13021302 - enterprise-dataplane-clusters
1303+ /api/kafkas_mgmt/v1/clusters/{id} :
1304+ delete :
1305+ operationId : deleteEnterpriseClusterById
1306+ parameters :
1307+ - description : Perform the action in an asynchronous manner
1308+ explode : true
1309+ in : query
1310+ name : async
1311+ required : true
1312+ schema :
1313+ type : boolean
1314+ style : form
1315+ - description : |-
1316+ When provided with value: true - enterprise cluster will be deleted alongside all kafkas present on the cluster.
1317+ When skipped and enterprise cluster has any kafkas associated with it, the request will fail.
1318+ explode: true
1319+ in: query
1320+ name: force
1321+ required: false
1322+ schema:
1323+ type: boolean
1324+ style: form
1325+ - description : ID of the enterprise data plane cluster
1326+ explode : false
1327+ in : path
1328+ name : id
1329+ required : true
1330+ schema :
1331+ type : string
1332+ style : simple
1333+ responses :
1334+ " 202 " :
1335+ content :
1336+ application/json :
1337+ schema :
1338+ $ref : ' #/components/schemas/Error'
1339+ description : Enterprise cluster deletion accepted
1340+ " 400 " :
1341+ content :
1342+ application/json :
1343+ examples :
1344+ " 400DeletionExample " :
1345+ $ref : ' #/components/examples/400DeletionExample'
1346+ schema :
1347+ $ref : ' #/components/schemas/Error'
1348+ description : Validation errors occurred
1349+ " 401 " :
1350+ content :
1351+ application/json :
1352+ examples :
1353+ " 401Example " :
1354+ $ref : ' #/components/examples/401Example'
1355+ schema :
1356+ $ref : ' #/components/schemas/Error'
1357+ description : Auth token is invalid
1358+ " 403 " :
1359+ content :
1360+ application/json :
1361+ examples :
1362+ " 403Example " :
1363+ $ref : ' #/components/examples/403Example'
1364+ schema :
1365+ $ref : ' #/components/schemas/Error'
1366+ description : User not authorized to access the service
1367+ " 404 " :
1368+ content :
1369+ application/json :
1370+ examples :
1371+ " 404DeleteExample " :
1372+ $ref : ' #/components/examples/404DeleteExample'
1373+ schema :
1374+ $ref : ' #/components/schemas/Error'
1375+ description : No Enterprise cluster with specified ID exists
1376+ " 500 " :
1377+ content :
1378+ application/json :
1379+ examples :
1380+ " 500DeleteExample " :
1381+ $ref : ' #/components/examples/500DeleteExample'
1382+ schema :
1383+ $ref : ' #/components/schemas/Error'
1384+ description : Unexpected error occurred
1385+ security :
1386+ - Bearer : []
1387+ tags :
1388+ - enterprise-dataplane-clusters
13031389components :
13041390 examples :
13051391 USRegionExample :
@@ -1325,6 +1411,7 @@ components:
13251411 href : /api/kafkas_mgmr/v1/clusters/abcd1234ascd3456fdks9485lskd030h
13261412 status : ready
13271413 cluster_id : abcd1234ascd3456fdks9485lskd030h
1414+ access_kafkas_via_private_network : true
13281415 KafkaRequestExample :
13291416 value :
13301417 id : 1iSY6RQ3JKI8Q0OTmjQFd3ocFRg
@@ -1551,7 +1638,7 @@ components:
15511638 code : KAFKAS-MGMT-45
15521639 reason : Enterprise cluster ID is invalid
15531640 operation_id : 1lWDGuybIrEnxrAem724gqkkiDv
1554- " 400MInvalidExternalClusterIdExample " :
1641+ " 400InvalidExternalClusterIdExample " :
15551642 value :
15561643 id : " 46"
15571644 kind : Error
@@ -1648,6 +1735,7 @@ components:
16481735 cluster_external_id : 69d631de-9b7f-4bc2-bf4f-4d3295a7b25e
16491736 cluster_ingress_dns_name : apps.enterprise-aws.awdk.s1.devshift.org
16501737 kafka_machine_pool_node_count : 9
1738+ access_kafkas_via_private_network : false
16511739 parameters :
16521740 id :
16531741 description : The ID of record
@@ -2257,8 +2345,13 @@ components:
22572345 kafka_machine_pool_node_count : 0
22582346 cluster_id : cluster_id
22592347 cluster_external_id : cluster_external_id
2348+ access_kafkas_via_private_network : true
22602349 cluster_ingress_dns_name : cluster_ingress_dns_name
22612350 properties :
2351+ access_kafkas_via_private_network :
2352+ description : Sets whether Kafkas created on this data plane cluster have
2353+ to be accessed via private network
2354+ type : boolean
22622355 cluster_id :
22632356 description : The data plane cluster ID. This is the ID of the cluster obtained
22642357 from OpenShift Cluster Manager (OCM) API
@@ -2281,6 +2374,7 @@ components:
22812374 format : int32
22822375 type : integer
22832376 required :
2377+ - access_kafkas_via_private_network
22842378 - cluster_external_id
22852379 - cluster_id
22862380 - cluster_ingress_dns_name
@@ -2440,12 +2534,18 @@ components:
24402534 type : object
24412535 EnterpriseCluster_allOf :
24422536 properties :
2537+ access_kafkas_via_private_network :
2538+ description : Indicates whether Kafkas created on this data plane cluster
2539+ have to be accessed via private network
2540+ type : boolean
24432541 cluster_id :
24442542 description : ocm cluster id of the registered Enterprise cluster
24452543 type : string
24462544 status :
24472545 description : status of registered Enterprise cluster
24482546 type : string
2547+ required :
2548+ - access_kafkas_via_private_network
24492549 type : object
24502550 VersionMetadata_allOf :
24512551 example :
@@ -2627,6 +2727,10 @@ components:
26272727 type : object
26282728 EnterpriseClusterRegistrationResponse_allOf :
26292729 properties :
2730+ access_kafkas_via_private_network :
2731+ description : Indicates whether Kafkas created on this data plane cluster
2732+ have to be accessed via private network
2733+ type : boolean
26302734 cluster_id :
26312735 description : OCM cluster id of the registered Enterprise cluster
26322736 type : string
@@ -2638,6 +2742,8 @@ components:
26382742 allOf :
26392743 - $ref : ' #/components/schemas/FleetshardParameter'
26402744 type : array
2745+ required :
2746+ - access_kafkas_via_private_network
26412747 type : object
26422748 securitySchemes :
26432749 Bearer :
0 commit comments