This repository has been archived by the owner on Nov 21, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
swagger.yaml
712 lines (709 loc) · 15.4 KB
/
swagger.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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
swagger: '2.0'
info:
version: "0.6.0-alpha"
title: Red Hat Open Innovation Labs API
description: "A generic model to support automation at all levels of the application and infrastructure lifecycle."
contact:
name: "Red Hat Open Innovation Labs"
url: "https://github.com/rht-labs/api-design"
email: "rhc-open-innovation-labs@redhat.com"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
paths:
/engagements:
post:
tags:
- engagement
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: '`Engagement` object to save'
required: true
schema:
$ref: "#/definitions/Engagement"
responses:
201:
description: 'Created'
headers:
Location:
type: string
description: 'Relative path to created Engagement'
400:
description: 'Invalid `Engagement`'
schema:
$ref: '#/definitions/ErrorModel'
500:
description: 'Unexpected Server Error'
schema:
$ref: '#/definitions/ErrorModel'
get:
tags:
- engagement
parameters:
-
name: nameIncludes
in: query
description: selects results that contain the query string, case insensitive, in `Engagement.name`
required: false
type: string
-
name: size
in: query
description: number of results to return
required: false
type: integer
format: int32
-
name: offset
in: query
description: offset in result set from beginning
required: false
type: integer
format: int64
responses:
200:
description: Collection of `Engagement` objects
schema:
title: Engagements
type: array
items:
$ref: "#/definitions/Engagement"
500:
description: Unexpected Server Error
schema:
$ref: '#/definitions/ErrorModel'
/engagements/{id}:
get:
tags:
- engagement
parameters:
-
name: id
in: path
required: true
type: integer
format: int64
responses:
200:
description: '`Engagement` of the given `id` returned'
schema:
$ref: "#/definitions/Engagement"
404:
description: '`Engagement` of the given `id` not found'
schema:
$ref: '#/definitions/ErrorModel'
500:
description: 'Unexpected Server Error'
schema:
$ref: '#/definitions/ErrorModel'
put:
tags:
- engagement
consumes:
- application/json
produces:
- application/json
parameters:
-
name: id
in: path
required: true
type: integer
format: int64
- in: body
name: body
required: true
schema:
$ref: "#/definitions/Engagement"
responses:
201:
description: 'Created New `Engagement`'
headers:
Location:
type: string
description: 'Relative path to created Engagement'
204:
description: '`Engagement` of Given `id` Updated'
schema:
$ref: "#/definitions/Engagement"
400:
description: 'Invalid `Engagement`'
schema:
$ref: '#/definitions/ErrorModel'
500:
description: 'Unexpected Server Error'
schema:
$ref: '#/definitions/ErrorModel'
delete:
tags:
- engagement
produces:
- application/json
parameters:
- in: path
name: id
required: true
type: integer
format: int64
responses:
204:
description: '`Engagement` of the given `id` deleted'
schema:
$ref: "#/definitions/Engagement"
404:
description: '`Engagement` of the given `id` not found'
schema:
$ref: '#/definitions/ErrorModel'
500:
description: 'Unexpected Server Error'
schema:
$ref: '#/definitions/ErrorModel'
/engagements/{id}/jenkinsfile:
get:
tags:
- engagement
- jenkinsfile
produces:
- text/plain
- application/json
parameters:
-
name: id
in: path
required: true
type: integer
format: int64
description: "Identifies which engagement to use"
-
name: applicationName
in: query
required: true
type: string
description: "`Application` in the `Engagement` to produce the Jenkinsfile for"
-
name: declarative
in: query
type: boolean
default: false
description: "Whether to use [declarative syntax](https://jenkins.io/blog/2017/01/12/declarative-pipeline-beta-2/). Defaults to `false`"
responses:
200:
description: "Successful response"
schema:
title: Jenkinsfile
type: string
400:
description: 'Bad request'
schema:
$ref: '#/definitions/ErrorModel'
404:
description: '`Engagement` of the given `id` not found'
schema:
$ref: '#/definitions/ErrorModel'
500:
description: 'Unexpected Server Error'
schema:
$ref: '#/definitions/ErrorModel'
/engagement-summaries:
get:
tags:
- engagement-summary
produces:
- application/json
parameters:
-
name: nameIncludes
in: query
description: selects results that contain the query string, case insensitive, in `EngagementSummary.name`
required: false
type: string
-
name: size
in: query
description: number of results to return
required: false
type: integer
format: int32
-
name: offset
in: query
description: offset in result set from beginning
required: false
type: integer
format: int64
responses:
200:
description: Collection of `EngagementSummary` objects
schema:
title: EngagementSummaries
type: array
items:
$ref: "#/definitions/EngagementSummary"
500:
description: Unexpected Server Error
schema:
$ref: '#/definitions/ErrorModel'
definitions:
Engagement:
properties:
id:
type: integer
format: int64
name:
type: string
start_date:
type: string
format: date
end_date:
type: string
format: date
openshift_clusters:
type: array
items:
$ref: "#/definitions/OpenShiftCluster"
users:
type: array
items:
$ref: '#/definitions/User'
user_groups:
type: array
items:
$ref: '#/definitions/Group'
required:
- id
- name
EngagementSummary:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
start_date:
type: string
format: date
end_date:
type: string
format: date
required:
- id
- name
OpenShiftCluster:
type: object
properties:
id:
type: integer
format: int64
labels:
type: object
additionalProperties:
type: string
openshift_resources:
$ref: '#/definitions/OpenShiftResources'
openshift_host_env:
type: string
image_registry:
type: string
persistent_volumes:
type: array
items:
$ref: '#/definitions/PersistentVolume'
required:
- id
PersistentVolume:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
capacity:
type: integer
format: int64
access_modes:
type: array
items:
type: string
enum:
- ReadWriteOnce
- ReadOnlyMany
- ReadWriteMany
nfs_path:
type: string
nfs_server:
type: string
reclaim_policy:
type: string
enum:
- Retain
- Recycle
labels:
type: object
additionalProperties:
type: string
OpenShiftResources:
type: object
properties:
id:
type: integer
format: int64
projects:
type: array
items:
$ref: "#/definitions/Project"
User:
type: object
properties:
id:
type: integer
format: int64
email:
type: string
format: email
first_name:
type: string
last_name:
type: string
user_name:
type: string
expiration_date:
type: string
format: date-time
required:
- email
- user_name
Project:
type: object
properties:
id:
type: integer
format: int64
display_name:
type: string
name:
type: string
environment_type:
type: string
enum:
- build
- promotion
apps:
type: array
items:
$ref: "#/definitions/Application"
templates:
type: array
items:
$ref: "#/definitions/Template"
pipelines:
type: array
items:
$ref: "#/definitions/Pipeline"
group_to_role:
type: array
items:
$ref: '#/definitions/GroupRoleMapping'
user_to_role:
type: array
items:
$ref: '#/definitions/RoleMapping'
persistent_volume_claims:
type: array
items:
$ref: '#/definitions/PersistentVolumeClaim'
required:
- name
PersistentVolumeClaim:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
access_modes:
type: array
items:
type: string
enum:
- ReadWriteOnce
- ReadOnlyMany
- ReadWriteMany
storage:
type: integer
format: int64
selector:
$ref: '#/definitions/LabelSelector'
LabelSelector:
type: object
properties:
id:
type: integer
format: int64
match_labels:
type: object
additionalProperties:
type: string
Application:
type: object
properties:
id:
type: integer
format: int64
base_image:
type: string
base_image_tag:
type: string
build_application_commands:
type: array
items:
type: string
build_tool:
type: string
build_image_commands:
type: array
items:
type: string
deploy_image_commands:
type: array
items:
type: string
context_dir:
type: string
scm_url:
type: string
scm_type:
type: string
scm_ref:
type: string
name:
type: string
labels:
type: object
additionalProperties:
type: string
environment_variables:
type: object
additionalProperties:
type: string
pvc_associations:
type: array
items:
$ref: '#/definitions/PVCAssociation'
routes:
type: array
items:
$ref: '#/definitions/Route'
Template:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
parameters:
type: object
additionalProperties:
type: string
Pipeline:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
imagestreams:
type: array
items:
type: string
Route:
type: object
discriminator: route_type
properties:
id:
type: integer
format: int64
name:
type: string
route_type:
type: string
enum:
- edge
- passthrough
- reencrypt
- default
hostname:
type: string
port:
type: integer
format: int
service:
$ref: '#/definitions/Service'
required:
- route_type
PassthroughRoute:
allOf:
- $ref: '#/definitions/Route'
- type: object
EdgeRoute:
allOf:
- $ref: '#/definitions/Route'
- type: object
properties:
ca_cert:
type: string
cert:
type: string
insecure_policy:
type: string
key:
type: string
path:
type: string
ReencryptRoute:
allOf:
- $ref: '#/definitions/Route'
- type: object
properties:
ca_cert:
type: string
cert:
type: string
dest_ca_cert:
type: string
insecure_policy:
type: string
key:
type: string
path:
type: string
Service:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
ports:
type: array
items:
$ref: '#/definitions/Port'
Port:
type: object
properties:
id:
type: integer
format: int64
port:
type: integer
format: int
protocol:
type: string
target_port:
type: integer
format: int
required:
- port
- protocol
- target_port
PVCAssociation:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
mount_path:
type: string
claim_type:
$ref: '#/definitions/ClaimType'
ClaimType:
type: object
properties:
id:
type: integer
format: int64
kind:
type: string
enum:
- secret
- claim
name:
type: string
GroupRoleMapping:
type: object
properties:
id:
type: integer
format: int64
group:
$ref: '#/definitions/Group'
roles:
type: array
items:
$ref: '#/definitions/Role'
required:
- group
- roles
Group:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
members:
type: array
items:
$ref: '#/definitions/User'
required:
- name
RoleMapping:
type: object
properties:
id:
type: integer
format: int64
user:
$ref: '#/definitions/User'
roles:
type: array
items:
$ref: '#/definitions/Role'
required:
- user
- roles
Role:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
required:
- name
ErrorModel:
type: object
required:
- message
- code
properties:
message:
type: string
code:
type: integer
minimum: 100
maximum: 600