Skip to content

Commit a4c2426

Browse files
chore(openapi): update kafka-mgmt/v1 OpenAPI document (#661)
Co-authored-by: app-services-ci <[email protected]>
1 parent 35cb8ef commit a4c2426

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

.openapi/kas-fleet-manager.yaml

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,8 @@ paths:
767767
'500':
768768
content:
769769
application/json:
770-
schema: { }
770+
schema:
771+
$ref: '#/components/schemas/Error'
771772
examples:
772773
500Example:
773774
$ref: '#/components/examples/500Example'
@@ -813,7 +814,8 @@ paths:
813814
'500':
814815
content:
815816
application/json:
816-
schema: { }
817+
schema:
818+
$ref: '#/components/schemas/Error'
817819
examples:
818820
500Example:
819821
$ref: '#/components/examples/500Example'
@@ -1454,7 +1456,6 @@ components:
14541456
description: The ID of the data plane where Kafka is deployed on. This information is only returned for kafka whose billing model is enterprise
14551457
type: string
14561458
nullable: true
1457-
14581459
promotion_details:
14591460
type: string
14601461
description: "Details of the Kafka request promotion. It can be set when a Kafka request promotion is in progress or has failed"
@@ -1572,7 +1573,6 @@ components:
15721573
description: enterprise OSD cluster ID to be used for kafka creation
15731574
type: string
15741575
nullable: true
1575-
15761576
KafkaPromoteRequest:
15771577
type: object
15781578
properties:
@@ -2021,7 +2021,6 @@ components:
20212021
description: Schema for the request body sent to /clusters POST
20222022
required:
20232023
- cluster_id
2024-
- cluster_external_id
20252024
- cluster_ingress_dns_name
20262025
- kafka_machine_pool_node_count
20272026
- access_kafkas_via_private_network
@@ -2033,9 +2032,6 @@ components:
20332032
cluster_id:
20342033
description: The data plane cluster ID. This is the ID of the cluster obtained from OpenShift Cluster Manager (OCM) API
20352034
type: string
2036-
cluster_external_id:
2037-
description: external cluster ID. Can be obtained from the response JSON of OCM get /api/clusters_mgmt/v1/clusters/<cluster_id>
2038-
type: string
20392035
cluster_ingress_dns_name:
20402036
description: dns name of the cluster. Can be obtained from the response JSON of the /api/clusters_mgmt/v1/clusters/<cluster_id>/ingresses (dns_name)
20412037
type: string
@@ -2198,7 +2194,7 @@ components:
21982194
Search criteria.
21992195
22002196
The syntax of this parameter is similar to the syntax of the `where` clause of an
2201-
SQL statement. Allowed fields in the search are `cloud_provider`, `name`, `owner`, `region`, and `status`. Allowed comparators are `<>`, `=`, `LIKE`, or `ILIKE`.
2197+
SQL statement. Allowed fields in the search are `cloud_provider`, `name`, `owner`, `region`, `status` and `cluster_id`. Allowed comparators are `<>`, `=`, `LIKE`, or `ILIKE`.
22022198
Allowed joins are `AND` and `OR`. However, you can use a maximum of 10 joins in a search query.
22032199
22042200
Examples:
@@ -2207,7 +2203,7 @@ components:
22072203
22082204
```
22092205
name = my-kafka and cloud_provider = aws
2210-
```[p-]
2206+
```
22112207
22122208
To return a Kafka instance with a name that starts with `my`, use the following syntax:
22132209
@@ -2623,7 +2619,6 @@ components:
26232619
EnterpriseOsdClusterPayloadExample:
26242620
value:
26252621
cluster_id: "1234abcd1234abcd1234abcd1234abcd"
2626-
cluster_external_id: "69d631de-9b7f-4bc2-bf4f-4d3295a7b25e"
26272622
cluster_ingress_dns_name: "apps.enterprise-aws.awdk.s1.devshift.org"
26282623
kafka_machine_pool_node_count: 9
26292624
access_kafkas_via_private_network: false

0 commit comments

Comments
 (0)