-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
1553 lines (1553 loc) · 42.2 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
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: SUPERSEDE ReleasePlanner API to UI
description: This API defines the operations that the Replan Controller component exposes to the Replan Dashboard (UI) component.
version: "2.1.4"
# the domain of the service
host: supersede.es.atos.net:8280
# array of all schemes that your API supports
schemes:
- http
# will be prefixed to all paths
basePath: /replan
produces:
- application/json
paths:
/projects:
get:
summary: Get projects
description: |
This operation retrieves a list of projects.
operationId: getProjects
tags:
- Projects
responses:
200:
description: An array of projects
schema:
type: array
items:
$ref: '#/definitions/Project'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
post:
summary: Create a new Project
description: |
This operation allows defining a new Project.
operationId: createProject
parameters:
- name: body
in: body
description: Project parameters
required: true
schema:
$ref: '#/definitions/NewProjectData'
tags:
- Projects
responses:
200:
description: A new Project
schema:
$ref: '#/definitions/Project'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}:
get:
summary: Get Project info
description: |
This operation returns the main info for a given Project: name, resources, effort unit, etc.
operationId: getProject
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
tags:
- Projects
responses:
200:
description: Project info
schema:
$ref: '#/definitions/Project'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
put:
summary: Modify Project
description: |
This operation allows modyfing some parameters of a given Project: effort unit, number of hours per effor unit and number of hours per week for a full time resource.
operationId: modifyProject
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: body
in: body
description: Project's parameters that can be modified
required: true
schema:
$ref: '#/definitions/ProjectData'
tags:
- Projects
responses:
200:
description: Success
schema:
$ref: '#/definitions/Project'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
delete:
summary: Remove a given Project
description: |
This operation allows removing a given Project.
operationId: deleteProject
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
tags:
- Projects
responses:
200:
description: Success
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}/features:
get:
summary: Get features
description: |
This operation returns a list of Features for a given Project. This list can be filtered by Feature status: pending or scheduled.
operationId: getFeatures
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: status
in: query
description: any | pending | in_release | scheduled
required: false
type: string
enum:
- any
- pending
- in_release
- scheduled
- name: code
in: query
description: comma-separated feature codes
required: false
type: array
uniqueItems: true
collectionFormat: csv
items:
type: integer
tags:
- Features
responses:
200:
description: An array of features
schema:
type: array
items:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}/features/create_one:
post:
summary: Create a new Feature
description: |
This operation allows defining a new Feature for a given Project.
operationId: createFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: body
in: body
description: Project parameters
required: true
schema:
$ref: '#/definitions/NewFeatureData'
tags:
- Features
responses:
200:
description: A new Feature
schema:
$ref: '#/definitions/Feature'
400:
description: Already exists feature with that 'code'
schema:
$ref: '#/definitions/Error'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}/features/{featureId}:
get:
summary: Get a feature given its ID
description: |
This operation returns the main info of a Feature given its featureID.
operationId: getFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the feature
required: true
tags:
- Features
responses:
200:
description: An array of features
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Feature not found
put:
summary: Modifies a given feature
description: |
This operation allows modifying some parameters of a given Feature: name, description, effort, deadline and priority.
operationId: modifyFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the feature
required: true
- name: body
in: body
description: Feature parameters that can be modified
required: true
schema:
$ref: '#/definitions/FeatureData'
tags:
- Features
responses:
200:
description: Success
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Feature not found
delete:
summary: Remove a given Feature
description: |
This operation allows removing a given Feature.
operationId: deleteFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the feature
required: true
tags:
- Features
responses:
200:
description: Success
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Feature not found
/projects/{projectId}/features/{featureId}/skills:
post:
summary: Adds required skills to a feature
description: |
This operation allows adding more required skills to a given Feature by providing a list of the Skill ids.
operationId: addSkillsToFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: body
in: body
description: Array of Skill ids
required: true
schema:
type: array
items:
$ref: '#/definitions/SkillId'
tags:
- Features
- Skills
responses:
200:
description: Success
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Feature not found
delete:
summary: Delete required skills from a feature
description: |
This operation allows deleting required skills from a given Feature by providing the Skill ids.
operationId: deleteSkillsFromFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: skill_id
in: query
description: IDs of the skills to remove
required: true
type: array
items:
type: number
format: int64
tags:
- Features
- Skills
responses:
200:
description: Success
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
/projects/{projectId}/features/{featureId}/dependencies:
post:
summary: Adds dependencies (to other features) to a feature
description: |
This operation allows adding more dependencies on other features by providing a list with the ids of those features
operationId: addDependenciesToFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: body
in: body
description: Array of Feature ids
required: true
schema:
type: array
items:
$ref: '#/definitions/FeatureId'
tags:
- Features
responses:
200:
description: Success
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Feature not found
delete:
summary: Delete dependencies (to other features) from a feature
description: |
This operation allows deleting dependencies on other features by providing the ids of those features
operationId: deleteDependenciesFromFeature
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: featureId
in: path
type: number
format: int64
description: ID of the feature
required: true
- name: feature_id
in: query
description: IDs of the features to remove as dependencies
required: true
type: array
items:
type: number
format: int64
tags:
- Features
responses:
200:
description: Success
schema:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
/projects/{projectId}/releases:
get:
summary: Get releases
operationId: getReleases
description: |
This operation returns a list with the Releases in a given Project.
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
tags:
- Releases
responses:
200:
description: An array of releases
schema:
type: array
items:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
post:
summary: Adds a new Release to the Project
description: |
This operation allows adding a new Release to a given Project by providing the following parameters: name, description and deadline
operationId: addNewReleaseToProject
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: body
in: body
description: Parameters of the new Release
required: true
schema:
$ref: '#/definitions/NewRelease'
tags:
- Releases
responses:
200:
description: A new release
schema:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}/releases/{releaseId}:
get:
summary: Get a release given its ID
description: |
This operation returns the main info of a Release given its releaseID.
operationId: getRelease
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the release
required: true
tags:
- Releases
responses:
200:
description: A Release
schema:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
put:
summary: Modify a given release
operationId: modifyRelease
description: |
This operation allows modifying a given Release providing new values for the following parameters: name, description and deadline
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the project
required: true
- name: body
in: body
description: Release parameters that can be modified
required: true
schema:
$ref: '#/definitions/ReleaseData'
tags:
- Releases
responses:
200:
description: Success
schema:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
delete:
summary: Remove a given Release.
operationId: deleteRelease
description: |
This operation allows removing a given Release from the Project.
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the project
required: true
tags:
- Releases
responses:
200:
description: Succes
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
/projects/{projectId}/releases/{releaseId}/resources:
post:
summary: Adds resources to a release
description: |
This operation allows assigning more resources to a given Release by providing a list with the Resource ids.
operationId: addResourcesToRelease
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: body
in: body
description: Array of Resource ids
required: true
schema:
type: array
items:
$ref: '#/definitions/ResourceId'
tags:
- Releases
- Resources
responses:
200:
description: Success
schema:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
delete:
summary: Delete resources from a release
description: |
This operation allows deallocating resources from a given Release by providing the ids of those resources.
operationId: deleteResourcesFromRelease
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: ResourceId
in: query
description: IDs of the resources to remove
required: true
type: array
items:
type: number
format: int64
tags:
- Releases
- Resources
responses:
200:
description: Success
schema:
$ref: '#/definitions/Release'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
/projects/{projectId}/releases/{releaseId}/features:
get:
summary: Get the features scheduled for a given release
description: |
This operation returns a list of the features scheduled for the given Release.
operationId: getReleaseFeatures
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
tags:
- Releases
- Features
responses:
200:
description: An array of features
schema:
type: array
items:
$ref: '#/definitions/Feature'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
post:
summary: Adds features to a release
description: |
This operation allows adding more features to a given Release by providing the list of the feature ids.
operationId: addFeaturesToRelease
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: body
in: body
description: Array of Feature ids
required: true
schema:
type: array
items:
$ref: '#/definitions/FeatureId'
tags:
- Releases
- Features
responses:
200:
description: Success
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
delete:
summary: Remove features from a relese
description: |
This operation allows removing features from a given Release by providing the Feature ids.
operationId: removeFeaturesFromRelease
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: featureId
in: query
description: IDs of the features to remove
required: true
type: array
items:
type: number
format: int64
tags:
- Releases
- Features
responses:
200:
description: Success
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project|Release|Feauture not found
/projects/{projectId}/releases/{releaseId}/plan:
get:
summary: Gets the current Release Plan
description: |
This operation calculates and then returns a new Release Plan for a given Release.
operationId: getReleasePlan
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: force_new
in: query
type: boolean
description: If true a new plan is created
required: false
tags:
- Releases
- Plan
responses:
200:
description: Success
schema:
$ref: '#/definitions/Plan'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
delete:
summary: Cancels the Release Plan
description: |
This operation cancels the Release Plan of the given Release.
operationId: cancelLastReleasePlan
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
tags:
- Releases
- Plan
responses:
200:
description: Success
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
put:
summary: Communicates completed jobs
description: |
This operation communicates plan's jobs that has been completed
operationId: notifyCompletedJobs
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: releaseId
in: path
type: number
format: int64
description: ID of the realese
required: true
- name: body
in: body
description: Array of {job_id, compteted_at}
required: true
schema:
type: array
items:
$ref: '#/definitions/CompletedJob'
tags:
- Releases
- Plan
- New in v2.1
responses:
200:
description: Success. Returns a (probably new) Release Plan
schema:
$ref: '#/definitions/Plan'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project or Release not found
/projects/{projectId}/skills:
get:
summary: Get project skills
description: |
This operation retrieves a list of the possible skills required in the given Project.
operationId: getProjectSkills
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
tags:
- Skills
responses:
200:
description: An array of skills
schema:
type: array
items:
$ref: '#/definitions/Skill'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
post:
summary: Create a new Skill
description: |
This operation allows defining a new Skill in the context of the given Project.
operationId: addNewSkillToProject
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: body
in: body
description: Skill parameters
required: true
schema:
$ref: '#/definitions/SkillData'
tags:
- Skills
responses:
200:
description: A new Skill
schema:
$ref: '#/definitions/Skill'
422:
description: Unprocessable Entity
schema:
$ref: '#/definitions/Error'
404:
description: Project not found
/projects/{projectId}/skills/{skillId}:
put:
summary: Modify a given Skill
description: |
This operation allows modifying the parameters of a given Skill, namely name and description.
operationId: modifySkill
parameters:
- name: projectId
in: path
type: string
description: ID of the project (e.g. "1" or "siemens")
required: true
- name: skillId
in: path
type: number
format: int64
description: ID of the project
required: true
- name: body
in: body
description: Skill parameters that can be modified
required: true
schema:
$ref: '#/definitions/SkillData'
tags:
- Skills
responses:
200: