-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
4580 lines (4579 loc) · 133 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: {}
basePath: /pabre-ws/api
tags:
- name: Schemas
- name: Pattern parts
- name: Patterns
- name: Pattern versions
- name: Dependencies
- name: Catalogue
- name: Sources
- name: Metrics
- name: Pattern forms
- name: Cost function
- name: Keywords
- name: Parameters
schemes:
- http
paths:
/catalogue/export:
get:
tags:
- Catalogue
summary: Export catalogue
description: 'Export catalogue with all the Sources, Keywords, Metrics, RequirementsPattern and Schemas, in JSON format so can be imported again<ul><li><em>TimeMetric</em> can have null values inside the date, that are marked as ''X''</li><ul>'
operationId: exportCatalogue
produces:
- application/json
parameters: []
responses:
'200':
description: 'OK: The export JSON has been created and returned.'
schema:
$ref: '#/definitions/ExportDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
/catalogue/ids:
get:
tags:
- Catalogue
summary: Check if the given ID is already used
description: 'Given a ID, check if this ID is already in use or not'
operationId: checkID
produces:
- application/json
parameters:
- name: id
in: query
description: ID to check
required: true
type: integer
format: int64
responses:
'200':
description: That ID is NOT beeing used
schema:
type: boolean
'400':
description: That ID is already being used
schema:
type: boolean
/catalogue/import:
post:
tags:
- Catalogue
summary: Import catalogue
description: 'Import a complete catalogue inside the system. <br/><strong>Important information</strong><ul> <li>If any ID is provided it will be assigned to that item</li><li>The <em>TimeMetric</em>, can have null values adding `XX` instead of any value, for example when you want to set null day possible can be: "2018-06-XX 16:53:20"</li><li> Order of creation of the imports:<ul><li> Creating a set of metric, first the simple metric should be indicated with the same id has idSimple</li><li>In case that a Set is composed of another set, then the inner set should be created before that it use it</li></ul></li><li><strong>Metrics</strong>: If the metric to import is a SetMetric, then the simple metric should have a ID and in the simpleId that ID should be indicated.</li><li><strong>Patterns</strong>: The sources, keywords and metrics are indicated by the name.</li><li><strong>Patterns</strong>: The cost function is indicated directly as costFunctions inside the versions.</li><li><strong>Schemas</strong>: The sources and patterns inside the classifiers are indicated by the name.</li></ul>'
operationId: importCatalogue
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: The JSON file to be imported
required: true
schema:
$ref: '#/definitions/ImportUnmarshaller'
responses:
'200':
description: 'OK: The request has succeeded and the catalogue element has been imported, the response will contain the IDs assigned.'
schema:
$ref: '#/definitions/ImportDTO'
'400':
description: 'Bad request: The request has not been applied because of wrong information to import, can be due to json malformed, missing mandatory field, unrecognized field, name already exists. For more information check the Body.'
schema:
type: string
'422':
description: 'Semantically Incorrect: The request has not been applied because the semantically incorrect information. check the body for more information'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
/catalogue/search:
get:
tags:
- Catalogue
summary: Search in catalogue
description: 'Given a list of words, separated by spaces, returns the reduced pattern information. the system search in the following elements: <ul><li><strong>Pattern</strong>: Search inside the <em>name</em> or <em>description</em></li><li><strong>Keywords</strong>: Search inside the last <em>version</em> keywords</li><li><strong>Forms</strong>: Search inside the <em>name</em> of all the forms inside the last version</li><ul>'
operationId: searchInCatalogue
produces:
- application/json
parameters:
- name: words
in: query
description: 'Words to search, all the words should be separated by space or tabs'
required: true
type: string
responses:
'200':
description: 'OK: Search completed, returned pattern accomplishing search criteria'
schema:
type: array
uniqueItems: true
items:
$ref: '#/definitions/RequirementPatternDTO'
'404':
description: 'Not Found: No pattern contains that words.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
/keywords:
get:
tags:
- Keywords
summary: List all the keywords
description: Returns all the keywords in the catalogue
operationId: getKeywords
produces:
- application/json
parameters: []
responses:
'200':
description: 'OK: The request has succeeded.'
schema:
type: array
items:
$ref: '#/definitions/KeywordDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
post:
tags:
- Keywords
summary: Create a keyword
description: Creates a new keyowrd
operationId: createKeyword
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Keyword to be created
required: true
schema:
$ref: '#/definitions/KeywordUnmarshaller'
responses:
'200':
description: 'OK: Keyword created'
schema:
$ref: '#/definitions/IdFormatter'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/keywords/{id}':
get:
tags:
- Keywords
summary: Retrieve a keyword
description: Get a keyword by ID
operationId: getKeyword
consumes:
- text/plain
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the keyword to obtain
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Keyword obtained'
schema:
$ref: '#/definitions/KeywordDTO'
'404':
description: 'Not Found: The requested keyword is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
put:
tags:
- Keywords
summary: Update a keyword
description: Update the given fields of the keyword
operationId: updateKeyword
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: new fields for keyword
required: true
schema:
$ref: '#/definitions/KeywordUnmarshaller'
- name: id
in: path
description: ID of the keyword to obtain
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Keyword updated'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested keyword is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Keywords
summary: Delete a keyword
description: Deletes a keyowrd
operationId: deleteKeyword
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the keyword to delete
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Keyword deleted'
schema:
$ref: '#/definitions/Response'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
/metrics:
get:
tags:
- Metrics
summary: List all the metrics
description: Returns all the metrics in the catalogue
operationId: getMetrics
produces:
- application/json
parameters:
- name: complete
in: query
description: True if the metric should have all the values
required: true
type: boolean
default: 'false'
responses:
'200':
description: 'OK: The request has succeeded.'
schema:
type: array
items:
$ref: '#/definitions/MetricDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
post:
tags:
- Metrics
summary: Create a Metric
description: 'Creates a new metric.<br/><br/> <ul><li>Before creating a SetMetric, the simple metric should be created</li></ul>'
operationId: createMetric
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: "The metric to be created should have this follow formats in JSON:<ul><li><h3><strong>Float</strong></h3>: The mandatory fields for a Float metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong>, <strong>MINVALUE</strong> and <strong>MAXVALUE</strong>.<br/>Example: <br/>{\r\n \"name\": \"float metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"minValue\": 0,\r\n \"maxValue\": 0,\r\n \"defaultValue\": 0\r\n} </li><li><h3><strong>Integer</strong></h3>: The mandatory fields for a Integer metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong>, <strong>MINVALUE</strong> and <strong>MAXVALUE</strong>.<br/>Example: <br/>{\r\n \"name\": \"integer metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"minValue\": 0,\r\n \"maxValue\": 0,\r\n \"defaultValue\": 0\r\n} </li><li><h3><strong>String</strong></h3>: The mandatory fields for a String metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"string metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"defaultValue\": \"\"\r\n} </li><li><h3><strong>Time</strong></h3>: The mandatory fields for a Time metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"time metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"date\": \"2014-12-25 22:56:44\"\r\n} </li><li><h3><strong>Set</strong></h3>: The mandatory fields for a Set metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong> and <strong>IDSIMPLE</strong>.<br/>Example: <br/>{\r\n \"name\": \"set metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"idSimple\": 0\r\n} </li><li><h3><strong>Domain</strong></h3>: The mandatory fields for a Domain metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"domain metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"defaultValue\": \"\",\r\n \"possibleValues\": [\"a\", \"b\", \"c\", \"d\"]\r\n} </li></ul>"
required: true
schema:
type: string
- name: type
in: query
description: Type of metric to be created
required: true
type: string
responses:
'200':
description: 'OK: Metric created'
schema:
$ref: '#/definitions/IdFormatter'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/metrics/{id}':
get:
tags:
- Metrics
summary: Retrieve a metric
description: Get a metric by ID
operationId: getMetric
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the metric to obtain
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Metric obtained'
schema:
$ref: '#/definitions/MetricDTO'
'404':
description: 'Not Found: The requested metric is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
put:
tags:
- Metrics
summary: Update a metric
description: Update the given fields of the metric
operationId: updateMetric
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: "The metric to be created should have this follow formats in JSON:<ul><li><h3><strong>Float</strong></h3>: The mandatory fields for a Float metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong>, <strong>MINVALUE</strong> and <strong>MAXVALUE</strong>.<br/>Example: <br/>{\r\n \"name\": \"float metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"minValue\": 0,\r\n \"maxValue\": 0,\r\n \"defaultValue\": 0\r\n} </li><li><h3><strong>Integer</strong></h3>: The mandatory fields for a Integer metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong>, <strong>MINVALUE</strong> and <strong>MAXVALUE</strong>.<br/>Example: <br/>{\r\n \"name\": \"integer metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"minValue\": 0,\r\n \"maxValue\": 0,\r\n \"defaultValue\": 0\r\n} </li><li><h3><strong>String</strong></h3>: The mandatory fields for a String metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"string metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"defaultValue\": \"\"\r\n} </li><li><h3><strong>Time</strong></h3>: The mandatory fields for a Time metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"time metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"date\": \"2014-12-25 22:56:44\"\r\n} </li><li><h3><strong>Set</strong></h3>: The mandatory fields for a Set metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong>, <strong>COMMENTS</strong> and <strong>IDSIMPLE</strong>.<br/>Example: <br/>{\r\n \"name\": \"set metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"idSimple\": 0\r\n} </li><li><h3><strong>Domain</strong></h3>: The mandatory fields for a Domain metric are: <strong>NAME</strong>, <strong>DESCRIPTION</strong> and <strong>COMMENTS</strong>.<br/>Example: <br/>{\r\n \"name\": \"domain metric\",\r\n \"description\": \"Metric desc.\",\r\n \"comments\": \"Metric comments\",\r\n \"sources\": [],\r\n \"defaultValue\": \"\",\r\n \"possibleValues\": [\"a\", \"b\", \"c\", \"d\"]\r\n} </li></ul>"
required: true
schema:
type: string
- name: id
in: path
description: ID of the metric to obtain
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Metric updated'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested metric is not found.'
schema:
type: string
'422':
description: 'Bad request: The request has not been applied because of somehing semantically incorrect.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Metrics
summary: Delete a Metric
description: Deletes a metric
operationId: deleteMetric
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the metric to delete
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Metric deleted'
schema:
$ref: '#/definitions/Response'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/pattern_elements/{id}/dependencies':
get:
tags:
- Dependencies
summary: Get all the dependencies
description: 'Get all the dependencies of the given element. DependencyClass can be:<ul><li>RequirementForm</li><li>RequirementPattern</li><li>RequirementPatternVersion</li><li>FixedPart</li><li>ExtendedPart</li><li>Parameter</li></ul>'
operationId: getDependencies
produces:
- application/json
parameters:
- name: id
in: path
description: Object ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependencies obtained'
schema:
$ref: '#/definitions/PatternObjectDTO'
'404':
description: 'Not Found: The requested element is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
post:
tags:
- Dependencies
summary: Replace dependencies of the given PatternObject
description: 'Replace all the dependencies to the pattern object, substitute the new dependencies with the old one.<br/><br/><strong>Important</strong> Dependency type only can be: <li>IMPLIES</li><li>EXCLUDES</li><li>CONTRIBUTES</li><li>DAMAGES</li><ul></ul><br/><strong>Important</strong> Dependency direction only can be: <li>UNIDIRECTIONAL</li><li>BIDIRECTIONAL</li><ul></ul>'
operationId: setNewDependencies
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Dependecies to add
required: true
schema:
$ref: '#/definitions/PatternObjectDependenciesUnmarshaller'
- name: id
in: path
description: PatternObject ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependecies created'
schema:
$ref: '#/definitions/Response'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
put:
tags:
- Dependencies
summary: Add all the dependecies to the pattern object
description: 'Add all the dependencies to the given pattern object<br/><br/><strong>Important</strong> Dependency type only can be: <li>IMPLIES</li><li>EXCLUDES</li><li>CONTRIBUTES</li><li>DAMAGES</li><ul></ul><br/><strong>Important</strong> Dependency direction only can be: <li>UNIDIRECTIONAL</li><li>BIDIRECTIONAL</li><ul></ul>'
operationId: addDependencies
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Dependencies to add
required: true
schema:
$ref: '#/definitions/PatternObjectDependenciesUnmarshaller'
- name: id
in: path
description: Pattern Element ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependencies substituted'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested element is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Dependencies
summary: Delete all the delependencies of the given component
description: Delete all the delependencies of the given component
operationId: deleteDependencies
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: Element ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependencies deleted'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested element is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/pattern_elements/{id}/dependencies/{idDependency}':
put:
tags:
- Dependencies
summary: Update a dependency
description: 'Update fields of given dependency<br/><br/><strong>Important</strong> Dependency type only can be: <li>IMPLIES</li><li>EXCLUDES</li><li>CONTRIBUTES</li><li>DAMAGES</li><ul></ul><br/><strong>Important</strong> Dependency direction only can be: <li>UNIDIRECTIONAL</li><li>BIDIRECTIONAL</li><ul></ul>'
operationId: updateDependency
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Unmarshaller with the given fields
required: true
schema:
$ref: '#/definitions/PutPatternObjectDependencyUnmarshaller'
- name: id
in: path
description: Element ID
required: true
type: integer
format: int64
- name: idDependency
in: path
description: Dependency ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependency updated'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested element is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Dependencies
summary: Delete a dependency
description: Delete a dependency
operationId: deleteDependency
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: Element ID
required: true
type: integer
format: int64
- name: idDependency
in: path
description: Dependency ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: dependency deleted'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested element is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
/patterns:
get:
tags:
- Patterns
summary: List all the pattern in the catalogue
description: List all the pattern in the catalogue
operationId: getPatterns
produces:
- application/json
parameters:
- name: keyword
in: query
description: Keyword that must have inside the pattern
required: false
type: string
- name: namesList
in: query
description: 'When is provided then the system will filter the patterns and will return only that ones who are inside the indicated internalClassifiers. The classifier is indicated as a path straight from the schema followed by RootClassifier and followed by N internalCLassifiers and the call will return the patterns inside the last internalClassifier.<strong>The list must have at least 3 names to search (SchemaClassifier/RootClassifier/InternalClassifier) and it must be <a href="https://www.w3schools.com/tags/ref_urlencode.asp">encoded</a>.</strong><ul><li>EXAMPLE: Get patterns from the inernalclassifier: <strong>schemaname1/rootname1/internal1/internal2/internal3</strong>. we have to make the request: /patterns?namesList=<strong>schemaname1</strong>&namesList=<strong>rootname1</strong>&namesList=<strong>internal1</strong>&namesList=<strong>internal2</strong>&namesList=<strong>internal3</strong></li></ul><br/>In case that you just give one name in the list is considered that the name of the classifiers are unique in this catalogue, so the search will happen in that classifier given in the list, otherwise returns a Error'
required: false
type: array
items:
type: string
collectionFormat: csv
- name: complete
in: query
description: 'Boolean telling that if the pattern should have all the fields or not, In case we are searching with the classifier names, if this parameter is true, then returns not only the patterns of that classifier, returns also the inner classifiers patterns'
required: false
type: boolean
default: 'false'
- name: completeClassifiers
in: query
description: 'Usefull only if the search is by classifiers names, if this parameter is true, then returns not only the patterns of that classifier, returns also the inner classifiers patterns'
required: false
type: boolean
default: 'false'
responses:
'200':
description: 'OK: The request has succeeded.'
schema:
type: array
uniqueItems: true
items:
$ref: '#/definitions/RequirementPatternDTO'
'404':
description: 'Not Found: The requested pattern, version is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
post:
tags:
- Patterns
summary: Create a new Pattern
description: 'Create a new pattern <br/><br/><strong>Important information</strong><ul> <li>All the <strong>keywords</strong> indicated <strong>must</strong> exists before creating the pattern.</li><li>All the <strong>sources</strong> indicated <strong>must</strong> exists before creating the pattern.</li><li>All the <strong>metrics</strong> indicated <strong>must</strong> exists before creating the pattern.</li><li>If the ID of the element is provided, that ID it will be assigned.</li></ul>'
operationId: createPattern
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Unmarshaller with the new pattern fields
required: true
schema:
$ref: '#/definitions/RequirementPatternUnmarshaller'
responses:
'200':
description: 'OK: Pattern created correctly'
schema:
$ref: '#/definitions/IdFormatter'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'422':
description: 'Bad request: The request has not been applied because of something semantically incorrect.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/patterns/{id}':
get:
tags:
- Patterns
summary: Get a pattern by ID
description: Return the pattern request by ID
operationId: getPattern
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the pattern
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Pattern obtained'
schema:
$ref: '#/definitions/RequirementFormDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
put:
tags:
- Patterns
summary: Update a pattern
description: 'Update the given pattern, if the ID is provided that ID will try to use, if the ID is already used throw a code 400 <strong>Important information</strong><ul> <li>All the <strong>Versions</strong>, <strong>Forms</strong>, <strong>FixedPart</strong>, <strong>ExtendedPart</strong>, <strong>Parameters</strong> <strong>MUST</strong> have a ID field.</li><li>If you change any element ID it will be changed inside the pattern.</li><li>All the <strong>keywords</strong> indicated <strong>must</strong> exists before creating the pattern.</li><li>All the <strong>sources</strong> indicated <strong>must</strong> exists before creating the pattern.</li><li>All the <strong>metrics</strong> indicated <strong>must</strong> exists before creating the pattern.</li></ul>'
operationId: updatePattern
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Unmarshaller with the new pattern fields
required: true
schema:
$ref: '#/definitions/RequirementPatternImportUnmarshaller'
- name: id
in: path
description: ID of the pattern
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Pattern updated'
schema:
$ref: '#/definitions/Response'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'404':
description: 'Not Found: The requested pattern is not found.'
schema:
type: string
'422':
description: 'Bad request: The request has not been applied because of somehing semantically incorrect.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Patterns
summary: Delete a Pattern
description: Deletes a pattern given the ID
operationId: deletePattern
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the pattern
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Pattern deleted'
schema:
$ref: '#/definitions/Response'
'404':
description: 'Not Found: The requested pattern is not found.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/patterns/{id}/dependencies':
get:
tags:
- Patterns
summary: Get all the dependencies of the pattern
description: 'Get all the dependencies of the given pattern and all the components inside of it (version, forms, parts, etc.)<br/>Given a ID of pattern, returns a list of all the dependencies of this patterns, includes the follow elements dependencies::<ul><li>RequirementPattern</li><li>PatternVersion</li><li>RequirementForm</li><li>FixedPart</li><li>ExtendedPart</li><li>Params</li></ul>'
operationId: getPatternCompleteDependencies
produces:
- application/json
parameters:
- name: id
in: path
description: ID of the pattern
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Request processed'
schema:
$ref: '#/definitions/CompletePatternDependenciesDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
'/patterns/{patternID}/versions/{versionID}/cost_function':
get:
tags:
- Cost function
summary: List all the Function cost of the given version
description: Returns all the function cost of the given pattern version
operationId: getAllFunctionCostFunctions
produces:
- application/json
parameters:
- name: patternID
in: path
description: Pattern ID
required: true
type: integer
format: int64
- name: versionID
in: path
description: Version ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: The request has succeeded.'
schema:
type: array
items:
$ref: '#/definitions/CostFunctionDTO'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
post:
tags:
- Cost function
summary: Create cost functions to given version
description: 'Given a set of cost functions, add them in the given parttern version'
operationId: addCostFunction
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Cost functions to be created
required: true
schema:
$ref: '#/definitions/CostFunctionsUnmarshaller'
- name: patternID
in: path
description: Pattern ID
required: true
type: integer
format: int64
- name: versionID
in: path
description: Version ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: functions created'
schema:
$ref: '#/definitions/Response'
'400':
description: 'Bad request: The request has not been applied because of wrong information, for more information check the Body.'
schema:
type: string
'422':
description: 'Bad request: The request has not been applied because of somehing semantically incorrect.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
put:
tags:
- Cost function
summary: Substitute the cost functions of given pattern
description: Substitute the cost functions of given pattern
operationId: updateCostFunctions
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Functions to be substituted
required: true
schema:
$ref: '#/definitions/CostFunctionsUnmarshaller'
- name: patternID
in: path
description: Pattern ID
required: true
type: integer
format: int64
- name: versionID
in: path
description: Version ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: functions substituted'
schema:
$ref: '#/definitions/Response'
'422':
description: 'Bad request: The request has not been applied because of somehing semantically incorrect.'
schema:
type: string
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
schema:
type: string
delete:
tags:
- Cost function
summary: Delete all the cost functions
description: Deletes all the functions
operationId: deleteAllCostFunctions
consumes:
- application/json
produces:
- application/json
parameters:
- name: patternID
in: path
description: Pattern ID
required: true
type: integer
format: int64
- name: versionID
in: path
description: Version ID
required: true
type: integer
format: int64
responses:
'200':
description: 'OK: Functions deleted'
schema:
$ref: '#/definitions/Response'