Skip to content

Commit

Permalink
fix(openapi): update kafka-mgmt/v1 OpenAPI document (#318)
Browse files Browse the repository at this point in the history
Co-authored-by: app-services-ci <[email protected]>
  • Loading branch information
app-services-ci and app-services-ci authored Jun 22, 2022
1 parent a3bcfdb commit a22b5c1
Showing 1 changed file with 8 additions and 36 deletions.
44 changes: 8 additions & 36 deletions .openapi/kas-fleet-manager.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.0 # need this as first line to allow some IDEs to know this is an o
# 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
info:
title: Kafka Service Fleet Manager
version: 1.8.0
version: 1.10.0
description: Kafka Service Fleet Manager is a Rest API to manage Kafka instances.
servers:
- url: https://api.openshift.com
Expand Down Expand Up @@ -462,22 +462,6 @@ paths:
- $ref: "#/components/parameters/id"
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/size'
- in: query
deprecated: true
name: instance_type
description: |-
The Kafka instance type to filter the results by
DEPRECATION NOTICE - instance_type will be deprecated
schema:
type: string
required: false
examples:
developer_instance_type:
value: "developer"
standard_instance_type:
value: "standard"
/api/kafkas_mgmt/v1/instance_types/{cloud_provider}/{cloud_region}:
get:
summary: Returns the list of supported Kafka instance types and sizes filtered by cloud provider and region
Expand Down Expand Up @@ -1025,6 +1009,8 @@ components:
type: string
marketplace:
type: string
billing_model:
type: string
example:
$ref: "#/components/examples/KafkaRequestExample"
KafkaRequestList:
Expand Down Expand Up @@ -1071,10 +1057,6 @@ components:
cloud_provider:
description: The cloud provider where the Kafka cluster will be created in
type: string
multi_az:
description: Deprecated. If it is specified, the value will be ignored. The API automatically determines this value from the 'plan' attribute"
type: boolean
deprecated: true
name:
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.'
type: string
Expand All @@ -1096,6 +1078,10 @@ components:
description: marketplace where the instance is purchased on
type: string
nullable: true
billing_model:
description: billing model to use
type: string
nullable: true
SupportedKafkaInstanceTypesList:
allOf:
- type: object
Expand Down Expand Up @@ -1265,15 +1251,6 @@ components:
description: 'Whether the region is enabled for deploying an OSD cluster.'
type: boolean
default: false
supported_instance_types:
deprecated: true
description: |-
The Kafka instance types supported by this region.
DEPRECATION NOTICE - instance_type will be deprecated
type: array
items:
type: string
capacity:
description: 'Indicates whether there is capacity left per instance type'
type: array
Expand Down Expand Up @@ -1332,10 +1309,6 @@ components:
instance_type:
description: 'kafka instance type'
type: string
max_capacity_reached:
description: 'flag indicating whether the capacity for the instance type in the region is reached'
type: boolean
deprecated: true
available_sizes:
description: 'list of available Kafka instance sizes that can be created in this region when taking account current capacity and regional limits'
type: array
Expand Down Expand Up @@ -1698,6 +1671,7 @@ components:
max_connection_attempts_per_sec: 100
billing_cloud_account_id: "123456789012"
marketplace: "aws"
billing_model: "marketplace"
KafkaRequestFailedCreationStatusExample:
value:
id: "1iSY6RQ3JKI8Q0OTmjQFd3ocFRg"
Expand Down Expand Up @@ -1758,11 +1732,9 @@ components:
id: "us-east-1"
display_name: "US East, N. Virginia"
enabled: true
supported_instance_types: ["standard"]
capacity: [
{
instance_type: "standard",
max_capacity_reached: true,
available_sizes: ["x1", "x2"]
}
]
Expand Down

0 comments on commit a22b5c1

Please sign in to comment.