88 name : Apache 2.0
99 url : https://www.apache.org/licenses/LICENSE-2.0
1010 title : Kafka Management API
11- version : 1.14 .0
11+ version : 1.15 .0
1212servers :
1313- description : Main (production) server
1414 url : https://api.openshift.com
@@ -285,6 +285,99 @@ paths:
285285 description : Unexpected error occurred
286286 security :
287287 - Bearer : []
288+ /api/kafkas_mgmt/v1/kafkas/{id}/promote :
289+ post :
290+ description : Promote a Kafka instance. Promotion is performed asynchronously.
291+ The `async` query parameter has to be set to `true`. Only kafka instances
292+ with an `eval` billing_model are supported
293+ operationId : promoteKafka
294+ parameters :
295+ - description : The ID of record
296+ explode : false
297+ in : path
298+ name : id
299+ required : true
300+ schema :
301+ type : string
302+ style : simple
303+ - description : Perform the action in an asynchronous manner. False by default.
304+ explode : true
305+ in : query
306+ name : async
307+ required : true
308+ schema :
309+ type : boolean
310+ style : form
311+ requestBody :
312+ content :
313+ application/json :
314+ examples :
315+ KafkaPromoteRequestExample :
316+ $ref : ' #/components/examples/KafkaPromoteRequestExample'
317+ schema :
318+ $ref : ' #/components/schemas/KafkaPromoteRequest'
319+ description : Kafka promotion request
320+ required : true
321+ responses :
322+ " 202 "
323+ description : Kafka promotion request accepted
324+ " 400 "
325+ content :
326+ application/json :
327+ examples :
328+ " 400CreationExample "
329+ $ref : ' #/components/examples/400CreationExample'
330+ schema :
331+ $ref : ' #/components/schemas/Error'
332+ description : Validation errors occurred
333+ " 401 "
334+ content :
335+ application/json :
336+ examples :
337+ " 401Example "
338+ $ref : ' #/components/examples/401Example'
339+ schema :
340+ $ref : ' #/components/schemas/Error'
341+ description : Auth token is invalid
342+ " 403 "
343+ content :
344+ application/json :
345+ examples :
346+ " 403Example "
347+ $ref : ' #/components/examples/403Example'
348+ schema :
349+ $ref : ' #/components/schemas/Error'
350+ description : User forbidden either because the user is not authorized to
351+ access the service.
352+ " 404 "
353+ content :
354+ application/json :
355+ examples :
356+ " 404Example "
357+ $ref : ' #/components/examples/404Example'
358+ schema :
359+ $ref : ' #/components/schemas/Error'
360+ description : The requested resource doesn't exist
361+ " 409 "
362+ content :
363+ application/json :
364+ examples :
365+ " 409NameConflictExample "
366+ $ref : ' #/components/examples/409NameConflictExample'
367+ schema :
368+ $ref : ' #/components/schemas/Error'
369+ description : A conflict has been detected with the usage of this resource
370+ " 500 "
371+ content :
372+ application/json :
373+ examples :
374+ " 500Example "
375+ $ref : ' #/components/examples/500Example'
376+ schema :
377+ $ref : ' #/components/schemas/Error'
378+ description : A server error occurred while promoting the Kafka request
379+ security :
380+ - Bearer : []
288381 /api/kafkas_mgmt/v1/kafkas :
289382 get :
290383 description : Returns a list of Kafka requests
@@ -1312,16 +1405,6 @@ paths:
13121405 schema :
13131406 type : boolean
13141407 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
13251408 - description : ID of the enterprise data plane cluster
13261409 explode : false
13271410 in : path
@@ -1608,6 +1691,11 @@ components:
16081691 failed_reason : a reason the Kafka request creation failed
16091692 instance_type : standard
16101693 reauthentication_enabled : true
1694+ KafkaPromoteRequestExample :
1695+ value :
1696+ desired_kafka_billing_model : marketplace
1697+ desired_marketplace : aws
1698+ desired_billing_cloud_account_id : " 123456"
16111699 SupportedKafkaInstanceTypeListExample :
16121700 value :
16131701 id : developer
@@ -2076,12 +2164,7 @@ components:
20762164 type : integer
20772165 total :
20782166 type : integer
2079- items :
2080- items :
2081- $ref : ' #/components/schemas/ObjectReference'
2082- type : array
20832167 required :
2084- - items
20852168 - kind
20862169 - page
20872170 - size
@@ -2195,6 +2278,32 @@ components:
21952278 required :
21962279 - name
21972280 type : object
2281+ KafkaPromoteRequest :
2282+ example :
2283+ desired_billing_cloud_account_id : desired_billing_cloud_account_id
2284+ desired_marketplace : desired_marketplace
2285+ desired_kafka_billing_model : desired_kafka_billing_model
2286+ properties :
2287+ desired_kafka_billing_model :
2288+ description : ' The desired Kafka billing model to promote the kafka instance
2289+ to. Promotion is performed asynchronously. Accepted values: ['' marketplace'' ,
2290+ '' standard'' ]'
2291+ minLength : 1
2292+ type : string
2293+ desired_marketplace :
2294+ description : ' The desired billing marketplace to promote the kafka instance
2295+ to. Accepted values: ['' aws'' , '' rhm'' ]. Only considered when desired_kafka_billing_model
2296+ is '' marketplace'' '
2297+ minLength : 1
2298+ type : string
2299+ desired_billing_cloud_account_id :
2300+ description : The desired Kafka billing cloud account ID to promote the kafka
2301+ instance to. Only considered when desired_kafka_billing_model is 'marketplace'
2302+ minLength : 1
2303+ type : string
2304+ required :
2305+ - desired_kafka_billing_model
2306+ type : object
21982307 SupportedKafkaInstanceTypesList :
21992308 allOf :
22002309 - $ref : ' #/components/schemas/SupportedKafkaInstanceTypesList_allOf'
@@ -2546,6 +2655,8 @@ components:
25462655 items :
25472656 $ref : ' #/components/schemas/Error'
25482657 type : array
2658+ required :
2659+ - items
25492660 type : object
25502661 KafkaRequest_allOf :
25512662 example :
@@ -2645,6 +2756,14 @@ components:
26452756 type : string
26462757 billing_model :
26472758 type : string
2759+ promotion_status :
2760+ description : ' Status of the Kafka request promotion. Possible values: ['' promoting'' ,
2761+ '' failed'' ]. If unset it means no promotion is in progress.'
2762+ type : string
2763+ promotion_details :
2764+ description : Details of the Kafka request promotion. It can be set when
2765+ a Kafka request promotion is in progress or has failed
2766+ type : string
26482767 required :
26492768 - multi_az
26502769 - reauthentication_enabled
@@ -2663,6 +2782,8 @@ components:
26632782 allOf :
26642783 - $ref : ' #/components/schemas/KafkaRequest'
26652784 type : array
2785+ required :
2786+ - items
26662787 type : object
26672788 EnterpriseClusterList_allOf :
26682789 example :
@@ -2678,6 +2799,8 @@ components:
26782799 allOf :
26792800 - $ref : ' #/components/schemas/EnterpriseCluster'
26802801 type : array
2802+ required :
2803+ - items
26812804 type : object
26822805 EnterpriseCluster_allOf :
26832806 properties :
@@ -2723,6 +2846,8 @@ components:
27232846 allOf :
27242847 - $ref : ' #/components/schemas/SupportedKafkaInstanceType'
27252848 type : array
2849+ required :
2850+ - items
27262851 type : object
27272852 CloudProviderList_allOf :
27282853 example :
@@ -2738,6 +2863,8 @@ components:
27382863 allOf :
27392864 - $ref : ' #/components/schemas/CloudProvider'
27402865 type : array
2866+ required :
2867+ - items
27412868 type : object
27422869 CloudRegionList_allOf :
27432870 example :
@@ -2753,6 +2880,8 @@ components:
27532880 allOf :
27542881 - $ref : ' #/components/schemas/CloudRegion'
27552882 type : array
2883+ required :
2884+ - items
27562885 type : object
27572886 ServiceAccount_allOf :
27582887 example :
0 commit comments