-
Notifications
You must be signed in to change notification settings - Fork 40
/
kas-fleet-manager-private-admin.yaml
382 lines (377 loc) · 12.4 KB
/
kas-fleet-manager-private-admin.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
openapi: 3.0.0
info:
title: Kafka Service Fleet Manager Admin APIs
description: The admin APIs for the fleet manager of Kafka service
version: 0.2.0
license:
name: 'Apache 2.0'
url: 'https://www.apache.org/licenses/LICENSE-2.0'
contact:
name: 'Red Hat Hybrid Cloud Console'
email: '[email protected]'
servers:
- url: https://api.openshift.com
description: Main (production) server
- url: https://api.stage.openshift.com
description: Staging server
- url: http://localhost:8000
description: localhost
- url: /
description: current domain
tags:
- name: Admin APIs
description: ""
paths:
'/api/kafkas_mgmt/v1/admin/kafkas':
get:
description: Returns a list of Kafkas
operationId: getKafkas
security:
- Bearer: []
responses:
"200":
description: Return a list of Kafka instances. This endpoint will return all Kafka instances that are stored in the database and the are not filtered based on user ids or org ids.
content:
application/json:
schema:
$ref: '#/components/schemas/KafkaList'
"400":
description: Bad request
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"401":
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"403":
description: User is not authorised to access the service
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"500":
description: Unexpected error occurred
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
parameters:
- $ref: 'kas-fleet-manager.yaml#/components/parameters/page'
- $ref: 'kas-fleet-manager.yaml#/components/parameters/size'
- $ref: 'kas-fleet-manager.yaml#/components/parameters/orderBy'
- $ref: 'kas-fleet-manager.yaml#/components/parameters/search'
'/api/kafkas_mgmt/v1/admin/kafkas/{id}':
get:
description: Return the details of Kafka instance by id
parameters:
- $ref: "kas-fleet-manager.yaml#/components/parameters/id"
security:
- Bearer: []
operationId: getKafkaById
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/Kafka'
description: Kafka found by ID
"401":
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"403":
description: User is not authorised to access the service
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"404":
description: No Kafka found with the specified ID
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"500":
description: Unexpected error occurred
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
patch:
description: Update a Kafka instance by id
parameters:
- $ref: "kas-fleet-manager.yaml#/components/parameters/id"
security:
- Bearer: []
operationId: updateKafkaById
requestBody:
description: Kafka update data
content:
application/json:
schema:
$ref: '#/components/schemas/KafkaUpdateRequest'
required: true
responses:
"200":
description: Kafka updated by ID
content:
application/json:
schema:
$ref: '#/components/schemas/Kafka'
"400":
description: Bad request
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"401":
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"403":
description: User is not authorised to access the service
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"404":
description: No Kafka found with the specified ID
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"500":
description: Unexpected error occurred
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
delete:
description: Delete a Kafka by ID
parameters:
- $ref: "kas-fleet-manager.yaml#/components/parameters/id"
- in: query
name: async
description: Perform the action in an asynchronous manner
schema:
type: boolean
required: true
security:
- Bearer: [ ]
operationId: deleteKafkaById
responses:
"200":
description: Kafka updated by ID
content:
application/json:
schema:
$ref: '#/components/schemas/Kafka'
"401":
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"403":
description: User is not authorised to access the service
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"404":
description: No Kafka found with the specified ID
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"500":
description: Unexpected error occurred
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
'/api/kafkas_mgmt/v1/admin/kafkas/{id}/revoke_tls_certificate':
post:
description: Revokes the automatically generated TLS wildcard certificate for the Kafka instance by id
parameters:
- $ref: "kas-fleet-manager.yaml#/components/parameters/id"
security:
- Bearer: []
operationId: revokeKafkaTLSCertificateBKafkaID
requestBody:
description: Kafka certificate revocation request payload.
content:
application/json:
schema:
$ref: '#/components/schemas/KafkacertificateRevocationRequest'
required: true
responses:
"204":
description: Kafka certificate successfully revoked
"400":
description: Bad request
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"401":
description: Auth token is invalid
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"403":
description: User is not authorised to access the service
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"404":
description: No Kafka found with the specified ID
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
"500":
description: Unexpected error occurred
content:
application/json:
schema:
$ref: 'kas-fleet-manager.yaml#/components/schemas/Error'
components:
schemas:
Kafka:
allOf:
- $ref: 'kas-fleet-manager.yaml#/components/schemas/ObjectReference'
- required:
- multi_az
- strimzi_upgrading
- kafka_upgrading
- kafka_ibp_upgrading
- type: object
properties:
status:
description: "Values: [accepted, preparing, provisioning, ready, failed, deprovision, deleting] "
type: string
cloud_provider:
description: "Name of Cloud used to deploy. For example AWS"
type: string
multi_az:
type: boolean
region:
description: "Values will be regions of specific cloud provider. For example: us-east-1 for AWS"
type: string
owner:
type: string
name:
type: string
bootstrap_server_host:
type: string
created_at:
format: date-time
type: string
updated_at:
format: date-time
type: string
failed_reason:
type: string
actual_kafka_version:
type: string
actual_strimzi_version:
type: string
desired_kafka_version:
type: string
desired_strimzi_version:
type: string
desired_kafka_ibp_version:
type: string
actual_kafka_ibp_version:
type: string
kafka_upgrading:
type: boolean
strimzi_upgrading:
type: boolean
kafka_ibp_upgrading:
type: boolean
organisation_id:
type: string
subscription_id:
type: string
owner_account_id:
type: string
account_number:
type: string
instance_type:
type: string
quota_type:
type: string
routes:
type: array
items:
type: object
properties:
domain:
type: string
router:
type: string
routes_created:
type: boolean
cluster_id:
type: string
namespace:
type: string
size_id:
type: string
max_data_retention_size:
$ref: '#/components/schemas/SupportedKafkaSizeBytesValueItem'
KafkaList:
allOf:
- $ref: "kas-fleet-manager.yaml#/components/schemas/List"
- type: object
required: [ items ]
properties:
items:
type: array
items:
allOf:
- $ref: "#/components/schemas/Kafka"
KafkaUpdateRequest:
type: object
properties:
# for now only support updating the following fields. May add more when use cases arise.
strimzi_version:
type: string
kafka_version:
type: string
kafka_ibp_version:
type: string
max_data_retention_size:
description: "Maximum data storage available to this Kafka"
type: string
suspended:
description: boolean value indicating whether kafka should be suspended or not depending on the value provided. Suspended kafkas have their certain resources removed and become inaccessible until fully unsuspended (restored to Ready state).
nullable: true
type: boolean
SupportedKafkaSizeBytesValueItem:
$ref: 'kas-fleet-manager.yaml#/components/schemas/SupportedKafkaSizeBytesValueItem'
KafkacertificateRevocationRequest:
type: object
properties:
revocation_reason:
type: integer
description: The certificate revocation reason. See https://www.rfc-editor.org/rfc/rfc5280#section-5.3.1 for the available reasons
example:
revocation_reason: 1 # key comprosised revocation reason
securitySchemes:
Bearer:
scheme: bearer
bearerFormat: JWT
type: http