Skip to content

Commit 4da2239

Browse files
chore(all): re-generate OpenAPI client(s) (#57)
Co-authored-by: app-services-ci <app-services-ci@users.noreply.github.com>
1 parent 79f536d commit 4da2239

53 files changed

Lines changed: 194 additions & 180 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

packages/kafka-management-sdk/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Kafka Service Fleet Manager
44

5-
- API version: 1.1.1
5+
- API version: 1.1.2
66

7-
Kafka Service Fleet Manager is a Rest API to manage Kakfa instances and connectors.
7+
Kafka Service Fleet Manager is a Rest API to manage Kafka instances.
88

99

1010
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
@@ -40,7 +40,7 @@ Add this dependency to your project's POM:
4040
<dependency>
4141
<groupId>com.redhat.cloud</groupId>
4242
<artifactId>kafka-management-sdk</artifactId>
43-
<version>1.1.1</version>
43+
<version>1.1.2</version>
4444
<scope>compile</scope>
4545
</dependency>
4646
```
@@ -50,7 +50,7 @@ Add this dependency to your project's POM:
5050
Add this dependency to your project's build file:
5151

5252
```groovy
53-
compile "com.redhat.cloud:kafka-management-sdk:1.1.1"
53+
compile "com.redhat.cloud:kafka-management-sdk:1.1.2"
5454
```
5555

5656
### Others
@@ -63,7 +63,7 @@ mvn clean package
6363

6464
Then manually install the following JARs:
6565

66-
- `target/kafka-management-sdk-1.1.1.jar`
66+
- `target/kafka-management-sdk-1.1.2.jar`
6767
- `target/lib/*.jar`
6868

6969
## Getting Started
@@ -111,14 +111,14 @@ All URIs are relative to *https://api.openshift.com*
111111

112112
Class | Method | HTTP request | Description
113113
------------ | ------------- | ------------- | -------------
114-
*DefaultApi* | [**createKafka**](docs/DefaultApi.md#createKafka) | **POST** /api/kafkas_mgmt/v1/kafkas | Creates a Kakfa request
115-
*DefaultApi* | [**deleteKafkaById**](docs/DefaultApi.md#deleteKafkaById) | **DELETE** /api/kafkas_mgmt/v1/kafkas/{id} | Deletes a Kakfa request by ID
114+
*DefaultApi* | [**createKafka**](docs/DefaultApi.md#createKafka) | **POST** /api/kafkas_mgmt/v1/kafkas | Creates a Kafka request
115+
*DefaultApi* | [**deleteKafkaById**](docs/DefaultApi.md#deleteKafkaById) | **DELETE** /api/kafkas_mgmt/v1/kafkas/{id} | Deletes a Kafka request by ID
116116
*DefaultApi* | [**getCloudProviderRegions**](docs/DefaultApi.md#getCloudProviderRegions) | **GET** /api/kafkas_mgmt/v1/cloud_providers/{id}/regions | Returns the list of supported regions of the supported cloud provider
117117
*DefaultApi* | [**getCloudProviders**](docs/DefaultApi.md#getCloudProviders) | **GET** /api/kafkas_mgmt/v1/cloud_providers | Returns the list of supported cloud providers
118-
*DefaultApi* | [**getKafkaById**](docs/DefaultApi.md#getKafkaById) | **GET** /api/kafkas_mgmt/v1/kafkas/{id} | Returns a Kakfa request by ID
118+
*DefaultApi* | [**getKafkaById**](docs/DefaultApi.md#getKafkaById) | **GET** /api/kafkas_mgmt/v1/kafkas/{id} | Returns a Kafka request by ID
119119
*DefaultApi* | [**getKafkas**](docs/DefaultApi.md#getKafkas) | **GET** /api/kafkas_mgmt/v1/kafkas | Returns a list of Kafka requests
120-
*DefaultApi* | [**getMetricsByInstantQuery**](docs/DefaultApi.md#getMetricsByInstantQuery) | **GET** /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query | Returns metrics with instant query by Kakfa ID
121-
*DefaultApi* | [**getMetricsByRangeQuery**](docs/DefaultApi.md#getMetricsByRangeQuery) | **GET** /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query_range | Returns metrics with timeseries range query by Kakfa ID
120+
*DefaultApi* | [**getMetricsByInstantQuery**](docs/DefaultApi.md#getMetricsByInstantQuery) | **GET** /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query | Returns metrics with instant query by Kafka ID
121+
*DefaultApi* | [**getMetricsByRangeQuery**](docs/DefaultApi.md#getMetricsByRangeQuery) | **GET** /api/kafkas_mgmt/v1/kafkas/{id}/metrics/query_range | Returns metrics with timeseries range query by Kafka ID
122122
*DefaultApi* | [**getServiceStatus**](docs/DefaultApi.md#getServiceStatus) | **GET** /api/kafkas_mgmt/v1/status | Returns the status of resources, such as whether maximum service capacity has been reached
123123
*DefaultApi* | [**getVersionMetadata**](docs/DefaultApi.md#getVersionMetadata) | **GET** /api/kafkas_mgmt/v1 | Returns the version metadata
124124
*SecurityApi* | [**createServiceAccount**](docs/SecurityApi.md#createServiceAccount) | **POST** /api/kafkas_mgmt/v1/service_accounts | Creates a service account

packages/kafka-management-sdk/api/openapi.yaml

Lines changed: 41 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
openapi: 3.0.0
22
info:
3-
description: Kafka Service Fleet Manager is a Rest API to manage Kakfa instances
4-
and connectors.
3+
description: Kafka Service Fleet Manager is a Rest API to manage Kafka instances.
54
title: Kafka Service Fleet Manager
6-
version: 1.1.1
5+
version: 1.1.2
76
servers:
87
- description: Main (production) server
98
url: https://api.openshift.com
@@ -112,7 +111,7 @@ paths:
112111
$ref: '#/components/examples/404DeleteExample'
113112
schema:
114113
$ref: '#/components/schemas/Error'
115-
description: No Kakfa request with specified ID exists
114+
description: No Kafka request with specified ID exists
116115
"500":
117116
content:
118117
application/json:
@@ -124,7 +123,7 @@ paths:
124123
description: Unexpected error occurred
125124
security:
126125
- Bearer: []
127-
summary: Deletes a Kakfa request by ID
126+
summary: Deletes a Kafka request by ID
128127
x-accepts: application/json
129128
get:
130129
operationId: getKafkaById
@@ -175,7 +174,7 @@ paths:
175174
$ref: '#/components/examples/404Example'
176175
schema:
177176
$ref: '#/components/schemas/Error'
178-
description: No Kakfa request with specified ID exists
177+
description: No Kafka request with specified ID exists
179178
"500":
180179
content:
181180
application/json:
@@ -187,7 +186,7 @@ paths:
187186
description: Unexpected error occurred
188187
security:
189188
- Bearer: []
190-
summary: Returns a Kakfa request by ID
189+
summary: Returns a Kafka request by ID
191190
x-accepts: application/json
192191
/api/kafkas_mgmt/v1/kafkas:
193192
get:
@@ -219,13 +218,13 @@ paths:
219218
Specifies the order by criteria. The syntax of this parameter is
220219
similar to the syntax of the `order by` clause of an SQL statement.
221220
Each query can be ordered by any of the `kafkaRequests` fields.
222-
For example, to return all Kakfa instances ordered by their name, use the following syntax:
221+
For example, to return all Kafka instances ordered by their name, use the following syntax:
223222
224223
```sql
225224
name asc
226225
```
227226
228-
To return all Kakfa instances ordered by their name _and_ created date, use the following syntax:
227+
To return all Kafka instances ordered by their name _and_ created date, use the following syntax:
229228
230229
```sql
231230
name asc, created_at asc
@@ -252,19 +251,19 @@ paths:
252251
253252
Examples:
254253
255-
To return a Kakfa instance with the name `my-kafka` and the region `aws`, use the following syntax:
254+
To return a Kafka instance with the name `my-kafka` and the region `aws`, use the following syntax:
256255
257256
```
258257
name = my-kafka and cloud_provider = aws
259258
```[p-]
260259
261-
To return a Kakfa instance with a name that starts with `my`, use the following syntax:
260+
To return a Kafka instance with a name that starts with `my`, use the following syntax:
262261
263262
```
264263
name like my%25
265264
```
266265
267-
If the parameter isn't provided, or if the value is empty, then all the Kakfa instances
266+
If the parameter isn't provided, or if the value is empty, then all the Kafka instances
268267
that the user has permission to see are returned.
269268
270269
Note. If the query is invalid, an error is returned.
@@ -384,6 +383,8 @@ paths:
384383
$ref: '#/components/examples/403Example'
385384
"403MaxAllowedInstanceReachedExample":
386385
$ref: '#/components/examples/403MaxAllowedInstanceReachedExample'
386+
"403TermsNotAcceptedExample":
387+
$ref: '#/components/examples/403TermsNotAcceptedExample'
387388
schema:
388389
$ref: '#/components/schemas/Error'
389390
description: User forbidden either because the user is not authorized to
@@ -418,7 +419,7 @@ paths:
418419
description: An unexpected error occurred while creating the Kafka request
419420
security:
420421
- Bearer: []
421-
summary: Creates a Kakfa request
422+
summary: Creates a Kafka request
422423
x-contentType: application/json
423424
x-accepts: application/json
424425
/api/kafkas_mgmt/v1/cloud_providers:
@@ -815,7 +816,7 @@ paths:
815816
type: integer
816817
style: form
817818
- description: List of metrics to fetch. Fetch all metrics when empty. List
818-
entries are Kakfa internal metric names.
819+
entries are Kafka internal metric names.
819820
explode: true
820821
in: query
821822
name: filters
@@ -853,7 +854,7 @@ paths:
853854
description: Unexpected error occurred
854855
security:
855856
- Bearer: []
856-
summary: Returns metrics with timeseries range query by Kakfa ID
857+
summary: Returns metrics with timeseries range query by Kafka ID
857858
x-accepts: application/json
858859
/api/kafkas_mgmt/v1/kafkas/{id}/metrics/query:
859860
get:
@@ -868,7 +869,7 @@ paths:
868869
type: string
869870
style: simple
870871
- description: List of metrics to fetch. Fetch all metrics when empty. List
871-
entries are Kakfa internal metric names.
872+
entries are Kafka internal metric names.
872873
explode: true
873874
in: query
874875
name: filters
@@ -906,7 +907,7 @@ paths:
906907
description: Unexpected error occurred
907908
security:
908909
- Bearer: []
909-
summary: Returns metrics with instant query by Kakfa ID
910+
summary: Returns metrics with instant query by Kafka ID
910911
x-accepts: application/json
911912
components:
912913
examples:
@@ -949,7 +950,7 @@ components:
949950
bootstrap_server_host: serviceapi-1isy6rq3jki8q0otmjqfd3ocfrg.apps.mk-bttg0jn170hp.x5u8.s1.devshift.org
950951
created_at: 2020-10-05T12:51:24.053142Z
951952
updated_at: 2020-10-05T12:56:36.362208Z
952-
failed_reason: a reason the Kakfa request creation failed
953+
failed_reason: a reason the Kafka request creation failed
953954
CloudProviderExample:
954955
value:
955956
kind: CloudProvider
@@ -1041,7 +1042,7 @@ components:
10411042
kind: Error
10421043
href: /api/kafkas_mgmt/v1/errors/23
10431044
code: KAFKAS-MGMT-23
1044-
reason: 'Failed to parse search query: Unable to list Kakfa requests for api_kafka_service:
1045+
reason: 'Failed to parse search query: Unable to list Kafka requests for api_kafka_service:
10451046
KAFKAS-MGMT-23: Failed to parse search query: Unsupported column name for
10461047
search: ''id''. Supported column names are: region, name, cloud_provider,
10471048
name, status. Query invalid: id = 123'
@@ -1085,6 +1086,14 @@ components:
10851086
code: KAFKAS-MGMT-5
10861087
reason: User 'foo-bar' has reached a maximum number of 6 allowed instances.
10871088
operation_id: 1lY3UiEkxnXBpVPeI2oNejd3XB
1089+
"403TermsNotAcceptedExample":
1090+
value:
1091+
id: "12"
1092+
kind: Error
1093+
href: /api/kafkas_mgmt/v1/errors/12
1094+
code: KAFKAS-MGMT-12
1095+
reason: Required terms have not been accepted
1096+
operation_id: kXCzWPeI2oXBpVPeI2LvF9jMQY
10881097
"409NameConflictExample":
10891098
value:
10901099
id: "36"
@@ -1156,7 +1165,7 @@ components:
11561165
style: form
11571166
filters:
11581167
description: List of metrics to fetch. Fetch all metrics when empty. List entries
1159-
are Kakfa internal metric names.
1168+
are Kafka internal metric names.
11601169
explode: true
11611170
in: query
11621171
name: filters
@@ -1196,13 +1205,13 @@ components:
11961205
Specifies the order by criteria. The syntax of this parameter is
11971206
similar to the syntax of the `order by` clause of an SQL statement.
11981207
Each query can be ordered by any of the `kafkaRequests` fields.
1199-
For example, to return all Kakfa instances ordered by their name, use the following syntax:
1208+
For example, to return all Kafka instances ordered by their name, use the following syntax:
12001209
12011210
```sql
12021211
name asc
12031212
```
12041213
1205-
To return all Kakfa instances ordered by their name _and_ created date, use the following syntax:
1214+
To return all Kafka instances ordered by their name _and_ created date, use the following syntax:
12061215
12071216
```sql
12081217
name asc, created_at asc
@@ -1230,19 +1239,19 @@ components:
12301239
12311240
Examples:
12321241
1233-
To return a Kakfa instance with the name `my-kafka` and the region `aws`, use the following syntax:
1242+
To return a Kafka instance with the name `my-kafka` and the region `aws`, use the following syntax:
12341243
12351244
```
12361245
name = my-kafka and cloud_provider = aws
12371246
```[p-]
12381247
1239-
To return a Kakfa instance with a name that starts with `my`, use the following syntax:
1248+
To return a Kafka instance with a name that starts with `my`, use the following syntax:
12401249
12411250
```
12421251
name like my%25
12431252
```
12441253
1245-
If the parameter isn't provided, or if the value is empty, then all the Kakfa instances
1254+
If the parameter isn't provided, or if the value is empty, then all the Kafka instances
12461255
that the user has permission to see are returned.
12471256
12481257
Note. If the query is invalid, an error is returned.
@@ -1477,12 +1486,17 @@ components:
14771486
$ref: '#/components/examples/KafkaRequestExample'
14781487
properties:
14791488
status:
1489+
description: 'Values: [accepted, preparing, provisioning, ready, failed,
1490+
deprovision, deleting] '
14801491
type: string
14811492
cloud_provider:
1493+
description: Name of Cloud used to deploy. For example AWS
14821494
type: string
14831495
multi_az:
14841496
type: boolean
14851497
region:
1498+
description: 'Values will be regions of specific cloud provider. For example:
1499+
us-east-1 for AWS'
14861500
type: string
14871501
owner:
14881502
type: string
@@ -1533,10 +1547,10 @@ components:
15331547
type: array
15341548
type: object
15351549
ServiceStatus_kafkas:
1536-
description: The Kakfa resource api status
1550+
description: The Kafka resource api status
15371551
properties:
15381552
max_capacity_reached:
1539-
description: Indicates whether we have reached Kakfa maximum capacity
1553+
description: Indicates whether we have reached Kafka maximum capacity
15401554
type: boolean
15411555
required:
15421556
- max_capacity_reached

0 commit comments

Comments
 (0)