Skip to content

Commit 5c5f155

Browse files
fix(openapi): update kafka-mgmt/v1 OpenAPI document (#444)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 50a5e5b commit 5c5f155

File tree

1 file changed

+8
-36
lines changed

1 file changed

+8
-36
lines changed

.openapi/kas-fleet-manager.yaml

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ openapi: 3.0.0 # need this as first line to allow some IDEs to know this is an o
22
# All endpoints defined here will be discoverable by all users. If there is a need to keep some endpoints "private", add them to the "managed-services-api-private.yaml" file
33
info:
44
title: Kafka Service Fleet Manager
5-
version: 1.8.0
5+
version: 1.10.0
66
description: Kafka Service Fleet Manager is a Rest API to manage Kafka instances.
77
servers:
88
- url: https://api.openshift.com
@@ -462,22 +462,6 @@ paths:
462462
- $ref: "#/components/parameters/id"
463463
- $ref: '#/components/parameters/page'
464464
- $ref: '#/components/parameters/size'
465-
- in: query
466-
deprecated: true
467-
name: instance_type
468-
description: |-
469-
The Kafka instance type to filter the results by
470-
471-
DEPRECATION NOTICE - instance_type will be deprecated
472-
473-
schema:
474-
type: string
475-
required: false
476-
examples:
477-
developer_instance_type:
478-
value: "developer"
479-
standard_instance_type:
480-
value: "standard"
481465
/api/kafkas_mgmt/v1/instance_types/{cloud_provider}/{cloud_region}:
482466
get:
483467
summary: Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
@@ -1025,6 +1009,8 @@ components:
10251009
type: string
10261010
marketplace:
10271011
type: string
1012+
billing_model:
1013+
type: string
10281014
example:
10291015
$ref: "#/components/examples/KafkaRequestExample"
10301016
KafkaRequestList:
@@ -1071,10 +1057,6 @@ components:
10711057
cloud_provider:
10721058
description: The cloud provider where the Kafka cluster will be created in
10731059
type: string
1074-
multi_az:
1075-
description: Deprecated. If it is specified, the value will be ignored. The API automatically determines this value from the 'plan' attribute"
1076-
type: boolean
1077-
deprecated: true
10781060
name:
10791061
description: 'The name of the Kafka cluster. It must consist of lower-case alphanumeric characters or ''-'', start with an alphabetic character, and end with an alphanumeric character, and can not be longer than 32 characters.'
10801062
type: string
@@ -1096,6 +1078,10 @@ components:
10961078
description: marketplace where the instance is purchased on
10971079
type: string
10981080
nullable: true
1081+
billing_model:
1082+
description: billing model to use
1083+
type: string
1084+
nullable: true
10991085
SupportedKafkaInstanceTypesList:
11001086
allOf:
11011087
- type: object
@@ -1265,15 +1251,6 @@ components:
12651251
description: 'Whether the region is enabled for deploying an OSD cluster.'
12661252
type: boolean
12671253
default: false
1268-
supported_instance_types:
1269-
deprecated: true
1270-
description: |-
1271-
The Kafka instance types supported by this region.
1272-
1273-
DEPRECATION NOTICE - instance_type will be deprecated
1274-
type: array
1275-
items:
1276-
type: string
12771254
capacity:
12781255
description: 'Indicates whether there is capacity left per instance type'
12791256
type: array
@@ -1332,10 +1309,6 @@ components:
13321309
instance_type:
13331310
description: 'kafka instance type'
13341311
type: string
1335-
max_capacity_reached:
1336-
description: 'flag indicating whether the capacity for the instance type in the region is reached'
1337-
type: boolean
1338-
deprecated: true
13391312
available_sizes:
13401313
description: 'list of available Kafka instance sizes that can be created in this region when taking account current capacity and regional limits'
13411314
type: array
@@ -1698,6 +1671,7 @@ components:
16981671
max_connection_attempts_per_sec: 100
16991672
billing_cloud_account_id: "123456789012"
17001673
marketplace: "aws"
1674+
billing_model: "marketplace"
17011675
KafkaRequestFailedCreationStatusExample:
17021676
value:
17031677
id: "1iSY6RQ3JKI8Q0OTmjQFd3ocFRg"
@@ -1758,11 +1732,9 @@ components:
17581732
id: "us-east-1"
17591733
display_name: "US East, N. Virginia"
17601734
enabled: true
1761-
supported_instance_types: ["standard"]
17621735
capacity: [
17631736
{
17641737
instance_type: "standard",
1765-
max_capacity_reached: true,
17661738
available_sizes: ["x1", "x2"]
17671739
}
17681740
]

0 commit comments

Comments
 (0)