-
Notifications
You must be signed in to change notification settings - Fork 0
/
dtz-containers-api.yaml
485 lines (485 loc) · 11.4 KB
/
dtz-containers-api.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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
openapi: 3.1.0
info:
title: DTZ Containers
version: 1.1.0
description: a generated client for the DTZ Containers API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
contact:
name: Jens Walter
email: jens@apimeister.com
servers:
- url: https://containers.dtz.rocks/api/{version}
variables:
version:
default: "2021-02-21"
enum:
- "2021-02-21"
paths:
/enable:
post:
summary: enable the containers service
operationId: enable
responses:
"200":
description: service enabled
/disable:
post:
summary: disable the containers service
operationId: disable
responses:
"200":
description: service disabled
/domain:
get:
summary: get all domains
operationId: getDomains
responses:
"200":
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Domain'
post:
summary: create a new domain
operationId: createDomain
requestBody:
description: register a new domain within dtz
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDomain'
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
"409":
description: domain already registered
/domain/{domain_name}:
get:
summary: get single domain
operationId: getDomain
parameters:
- in: path
name: domain_name
schema:
type: string
required: true
description: name of the domain
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
delete:
summary: delete single domain
operationId: deleteDomain
parameters:
- in: path
name: domain_name
schema:
type: string
required: true
description: name of the domain
responses:
"200":
description: success
patch:
summary: trigger domain verification
operationId: verifyDomain
parameters:
- in: path
name: domain_name
schema:
type: string
required: true
description: name of the domain
responses:
"200":
description: success
"500":
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/service:
get:
summary: get current container services
operationId: getServices
responses:
"200":
description: status
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Service'
post:
summary: create a new service hosting
operationId: createService
requestBody:
description: creation request
content:
application/json:
schema:
$ref: '#/components/schemas/CreateService'
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
/service/{serviceId}:
get:
summary: get service
operationId: getService
parameters:
- in: path
name: serviceId
schema:
type: string
format: ServiceId
required: true
description: service id
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
post:
summary: update service
operationId: updateService
parameters:
- in: path
name: serviceId
schema:
type: string
format: ServiceId
required: true
description: service id
requestBody:
description: update request
content:
application/json:
schema:
type: object
properties:
prefix:
type: string
containerImage:
type: string
containerImageVersion:
type: string
containerPullUser:
type: string
containerPullPwd:
type: string
envVariables:
type: object
required:
- prefix
- containerImage
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Service'
delete:
summary: delete service
operationId: deleteService
parameters:
- in: path
name: serviceId
schema:
type: string
format: ServiceId
required: true
description: service id
responses:
"200":
description: success
/job:
get:
summary: list all jobs
operationId: getJobs
responses:
"200":
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/JobResponse'
post:
summary: create new job
operationId: createJob
requestBody:
description: update existing hosting
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJob'
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
/job/{job_id}:
get:
summary: get single job
operationId: getJob
parameters:
- in: path
name: job_id
schema:
type: string
format: JobId
required: true
description: uuid of the job
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
post:
summary: update single job
operationId: updateJob
parameters:
- in: path
name: job_id
schema:
type: string
format: JobId
required: true
description: uuid of the job
responses:
"200":
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/JobResponse'
patch:
summary: trigger single job
operationId: triggerJob
parameters:
- in: path
name: job_id
schema:
type: string
format: JobId
required: true
description: uuid of the job
responses:
"200":
description: success
delete:
summary: delete single job
operationId: deleteJob
parameters:
- in: path
name: job_id
schema:
type: string
format: JobId
required: true
description: uuid of the job
responses:
"200":
description: success
components:
schemas:
ErrorResponse:
type: object
properties:
msg:
type: string
CreateJob:
type: object
properties:
name:
type: string
containerImage:
type: string
containerPullUser:
type: string
containerPullPwd:
type: string
scheduleType:
type: string
enum:
- relaxed
- precise
- none
scheduleCron:
type: string
scheduleRepeat:
type: string
envVariables:
type: object
additionalProperties:
type: string
required:
- name
- containerImage
- scheduleType
JobResponse:
type: object
properties:
id:
type: string
format: JobId
name:
type: string
containerImage:
type: string
containerPullUser:
type: string
containerPullPwd:
type: string
scheduleType:
type: string
enum:
- relaxed
- precise
- none
scheduleRepeat:
type: string
scheduleCron:
type: string
envVariables:
type: object
additionalProperties:
type: string
required:
- id
- name
- containerImage
- scheduleType
Domain:
type: object
properties:
contextId:
type: string
format: ContextId
name:
type: string
verified:
type: boolean
created:
type: string
format: date-time
required:
- contextId
- name
- verified
- created
CreateDomain:
type: object
properties:
name:
type: string
required:
- name
Service:
type: object
properties:
contextId:
type: string
format: ContextId
serviceId:
type: string
format: ServiceId
created:
type: string
format: date-time
prefix:
type: string
containerImage:
type: string
containerImageVersion:
type: string
containerPullUser:
type: string
containerPullPwd:
type: string
envVariables:
type: object
additionalProperties:
type: string
login:
type: object
properties:
providerName:
type: string
required:
- providerName
required:
- contextId
- serviceId
- created
- prefix
- containerImage
CreateService:
type: object
properties:
prefix:
type: string
containerImage:
type: string
containerImageVersion:
type: string
containerPullUser:
type: string
containerPullPwd:
type: string
envVariables:
type: object
additionalProperties:
type: string
login:
type: object
properties:
providerName:
type: string
required:
- providerName
required:
- prefix
- containerImage
securitySchemes:
dtz_auth:
type: apiKey
in: header
name: X-API-KEY
dtz_auth2:
type: oauth2
flows:
implicit:
authorizationUrl: https://identity.dtz.rocks/api/2021-02-21/token/auth
scopes:
dummy:dummy: dummy
security:
- dtz_auth: []
- dtz_auth2: []