forked from elastest/elastest-torm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
1057 lines (1057 loc) · 28.1 KB
/
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
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:
description: REST API description of the ElasTest TORM Module.
version: '0.1.1'
title: ElasTest Torm REST API
contact: {}
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: 'localhost:8091'
basePath: /
paths:
/api/external/tjob:
post:
tags:
- External
summary: Create new TJob associated with an external Job
description: 'The association is based on the name of the external Job received. The Project and the TJob that will be created will have the same name as the one received as a parameter. If a Project or Job already exists with the received name, a new one will not be created.'
operationId: createExternalTJobUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: ExternalJob object that needs to create
required: true
schema:
$ref: '#/definitions/ExternalJob'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ExternalJob'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
schema:
$ref: '#/definitions/ExternalJob'
put:
tags:
- External
summary: Receives the completion signal of an External Job
description: Sets the execution of TJob in the Completed state.
operationId: finishExternalJobUsingPUT
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: ExternalJob configuration
required: true
schema:
$ref: '#/definitions/ExternalJob'
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
/api/project:
get:
tags:
- Project
summary: Returns all projects
description: Returns the projects and the detailed information of each of them.
operationId: getAllProjectsUsingGET
consumes:
- application/json
produces:
- '*/*'
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/Project'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Resources not found
post:
tags:
- Project
summary: Creates a new ElasTest Project
description: 'Creates a new Project entity for a given name.This method, at least must receive as input a JSON with the following fields: name.'
operationId: createProjectUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Object with the data of the project to be created.
required: true
schema:
$ref: '#/definitions/Project'
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/Project'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
'/api/project/{id}':
get:
tags:
- Project
summary: Returns the project found for a given ID
description: Returns the project found for a given id and its detail.
operationId: getProjectUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
description: id
required: true
type: integer
format: int64
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/Project'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
delete:
tags:
- Project
summary: Deletes a Project
description: Deletes the project whose id matches for a given id.
operationId: deleteProjectUsingDELETE
consumes:
- application/json
produces:
- '*/*'
parameters:
- name: id
in: path
description: ID of Project to delete.
required: true
type: integer
format: int64
responses:
'200':
description: Deleteted successful
schema:
type: integer
format: int64
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Project not found
schema:
type: integer
format: int64
/api/sut:
get:
tags:
- SUT
summary: List all SUT definitions
description: Returns a list of all SUT definitions.
operationId: getSutListUsingGET
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/SutSpecification'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: SUTs not found
post:
tags:
- SUT
summary: Creates a new SuT Description
description: 'A SUT will be associated with a Project. This method, at least must receive as input a JSON with the following fields: name, imageName, project, specification'
operationId: createSuTUsingPOST
consumes:
- application/json
produces:
- '*/*'
parameters:
- in: body
name: body
description: SuT configuration
required: true
schema:
$ref: '#/definitions/SutSpecification'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SutSpecification'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
put:
tags:
- SUT
summary: Updates an existing SUT Description
description: Updates a SUT with the request body data.
operationId: modifySutUsingPUT
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: SuT configuration
required: true
schema:
$ref: '#/definitions/SutSpecification'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SutSpecification'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
schema:
$ref: '#/definitions/SutSpecification'
'/api/sut/{sutId}':
get:
tags:
- SUT
summary: Returns a SUT
description: Returns the SUT that matches for a given id.
operationId: getSutByIdUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: sutId
in: path
description: SuT id to return.
required: true
type: integer
format: int64
responses:
'200':
description: SUT returned successfully
schema:
$ref: '#/definitions/SutSpecification'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
delete:
tags:
- SUT
summary: Deletes a SUT
description: Deletes the SUT whose id matches with a given id.
operationId: deleteSuTUsingDELETE
consumes:
- application/json
produces:
- application/json
parameters:
- name: sutId
in: path
description: SuT id to delete
required: true
type: integer
format: int64
responses:
'200':
description: SUT deleteted successfully
schema:
type: integer
format: int64
'204':
description: No Content
'400':
description: Invalid SUT ID supplied
schema:
type: integer
format: int64
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: SUT not found
schema:
type: integer
format: int64
'/api/sut/{sutId}/exec':
get:
tags:
- SUT Execution
summary: List all SUT executions
description: Returns a list of all SUT Executions for a given SUT.
operationId: getAllSutExecBySutUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: sutId
in: path
description: Sut id
required: true
type: integer
format: int64
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/SutExecution'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: SUTs not found
schema:
$ref: '#/definitions/SutExecution'
'/api/sut/{sutId}/exec/{sutExecId}':
get:
tags:
- SUT Execution
summary: Returns a SUT Execution.
description: Returns the SUT Execution whose id matches with a given id.
operationId: getSutExecUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: sutId
in: path
description: SuT id to get info
required: true
type: integer
format: int64
- name: sutExecId
in: path
description: SuT Execution id to get info
required: true
type: integer
format: int64
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SutExecution'
'400':
description: Invalid SUT ID supplied
schema:
$ref: '#/definitions/SutExecution'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: SUT not found
schema:
$ref: '#/definitions/SutExecution'
delete:
tags:
- SUT Execution
summary: Deletes a SUT execution
description: Deteltes the SUT Execution whose id matches with a given id.
operationId: deleteSuTExecUsingDELETE
consumes:
- application/json
produces:
- application/json
parameters:
- name: sutExecId
in: path
description: SuT execution id to delete
required: true
type: integer
format: int64
responses:
'200':
description: SUT Execution deleteted successfully
schema:
type: integer
format: int64
'204':
description: No Content
'400':
description: Invalid SUT Execution ID supplied
schema:
type: integer
format: int64
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: SUT Execution not found
schema:
type: integer
format: int64
/api/tjob:
get:
tags:
- TJob
summary: Returns all tjobs
description: Returns all TJobs.
operationId: getAllTJobsUsingGET
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/TJob'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Resource not found
post:
tags:
- TJob
summary: Create a new TJob
description: 'Creates a new TJob associated with an existing project. This method, at least must receive as input a JSON with the following fields: TJob name, imageName, external and project.'
operationId: createTJobUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: TJob object that needs to create
required: true
schema:
$ref: '#/definitions/TJob'
responses:
'200':
description: Creation successful
schema:
$ref: '#/definitions/TJob'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
put:
tags:
- TJob
summary: Modifies a existing TJob
description: Modifies the TJob that matches the received TJob.
operationId: modifyTJobUsingPUT
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
description: Tjob object that needs to modify.
required: true
schema:
$ref: '#/definitions/TJob'
responses:
'200':
description: TJob Mofification Successful
schema:
$ref: '#/definitions/TJob'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
'405':
description: Invalid input
schema:
$ref: '#/definitions/TJob'
'/api/tjob/{tJobId}':
get:
tags:
- TJob
summary: Returns a TJob
description: Returns the TJob identified by the received id with all its detailed data.
operationId: getTJobByIdUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: tJobId
in: path
description: ID of tJob to retrieve.
required: true
type: integer
format: int64
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/TJob'
'400':
description: TJob not found.
schema:
$ref: '#/definitions/TJob'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
delete:
tags:
- TJob
summary: Deletes a TJob
description: Deletes the TJob identified by the received id.
operationId: deleteTJobUsingDELETE
consumes:
- application/json
produces:
- '*/*'
parameters:
- name: tJobId
in: path
description: ID of TJob to delete.
required: true
type: integer
format: int64
responses:
'200':
description: Deleteted successful
schema:
type: integer
format: int64
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: TJob not found
schema:
type: integer
format: int64
'/api/tjob/{tJobId}/exec':
get:
tags:
- TJob Execution
summary: Returns all TJob Executions of a TJob
description: Returns all TJob Executions of a TJob.
operationId: getTJobsExecutionsByTJobUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: tJobId
in: path
description: TJob Id.
required: true
type: integer
format: int64
responses:
'200':
description: Successful operation
schema:
type: array
items:
$ref: '#/definitions/TJobExecution'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: TJobs Executions not found
post:
tags:
- TJob Execution
summary: Executes a TJob
description: Execute the TJob with the received id.
operationId: execTJobUsingPOST
consumes:
- application/json
produces:
- application/json
parameters:
- name: tJobId
in: path
description: TJob Id.
required: true
type: integer
format: int64
- in: body
name: parameters
description: Parameters
required: true
schema:
type: array
items:
$ref: '#/definitions/Parameter'
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/TJobExecution'
'201':
description: Created
'400':
description: Invalid ID supplied
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: TJob not found
'500':
description: Server Error
'/api/tjob/{tJobId}/exec/{tJobExecId}':
get:
tags:
- TJob Execution
summary: Returns a TJob Execution
description: Returns the TJob Execution for a given id.
operationId: getTJobsExecutionUsingGET
consumes:
- application/json
produces:
- application/json
parameters:
- name: tJobId
in: path
description: TJob Id.
required: true
type: integer
format: int64
- name: tJobExecId
in: path
description: TJob Execution Id.
required: true
type: integer
format: int64
responses:
'200':
description: Successful operation
schema:
$ref: '#/definitions/TJobExecution'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: TJob Execution not found
delete:
tags:
- TJob Execution
summary: Deletes a TJob Execution
description: Deletes the TJob Execution for a given id.
operationId: deleteTJobExecutionUsingDELETE
consumes:
- application/json
produces:
- '*/*'
parameters:
- name: tJobId
in: path
description: TJob Id.
required: true
type: integer
format: int64
- name: tJobExecId
in: path
description: TJob Execution Id.
required: true
type: integer
format: int64
responses:
'200':
description: Successful operation
schema:
type: integer
format: int64
'204':
description: No Content
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: TJob Execution not found
schema:
type: integer
format: int64
definitions:
Project:
type: object
required:
- name
properties:
id:
type: integer
format: int64
description: Id of the Project.
name:
type: string
description: The project name.
suts:
type: array
description: The Suts list associated with the project.
items:
$ref: '#/definitions/SutSpecification'
tjobs:
type: array
description: The TJobs list associated with the project.
items:
$ref: '#/definitions/TJob'
description: 'ElasTest organizes your work in projects, each of which will contain the different tests and SUTs that you want to create.'
TestSuite:
type: object
properties:
errors:
type: integer
format: int32
failures:
type: integer
format: int32
flakes:
type: integer
format: int32
id:
type: integer
format: int64
name:
type: string
numTests:
type: integer
format: int32
skipped:
type: integer
format: int32
tJobExec:
$ref: '#/definitions/TJobExecution'
testCases:
type: array
items:
$ref: '#/definitions/TestCase'
timeElapsed:
type: number
format: double
description: Object that contains the information of a test suit results.
TestCase:
type: object
properties:
failureDetail:
type: string
failureErrorLine:
type: string
failureMessage:
type: string
failureType:
type: string
id:
type: integer
format: int64
name:
type: string
testSuite:
$ref: '#/definitions/TestSuite'
time:
type: number
format: double
description: Object that contains the information of the test results.
SutExecution:
type: object
required:
- url
properties:
deployStatus:
type: string
example: deploying
description: 'Status of the SUT (deploying, deployed, undeploying, undeployed and error)'
enum:
- deploying
- deployed
- undeploying
- undeployed
- error
id:
type: integer
format: int64
example: 12345678
description: Value that identifies a SUT Execution.
sutSpecification:
example: MySut
description: SUT deployed
$ref: '#/definitions/SutSpecification'
url:
type: string
example: 'http://www.myapp.io:8090'
description: URL to access the SUT.
description: Data generated by the execution of a SUT.
TJobExecution:
type: object
required:
- duration
- id
- result
properties:
duration:
type: integer
format: int64
error:
type: string
id:
type: integer
format: int64
logIndex:
type: string
parameters:
type: array
items:
$ref: '#/definitions/Parameter'
result:
type: string
enum:
- FINISHED
- FAILURE
- IN PROGRESS
sutExecution:
$ref: '#/definitions/SutExecution'
tJob:
$ref: '#/definitions/TJob'
testSuite:
$ref: '#/definitions/TestSuite'
tjob:
$ref: '#/definitions/TJob'
description: Data generated by the execution of a TJob.
Parameter:
type: object
properties:
name:
type: string
example: ELASTEST_HOME
description: Name of the Environment Variable.
value:
type: string
example: /bin/elastest
description: Value of the Environment Variable.
description: Environment Variable to pass to a docker container.
SutSpecification:
type: object
required:
- imageName
- name
- project
- specification
properties:
description:
type: string
example: My Web Application
description: Brief description of a SUT
id:
type: integer
format: int64
description: Value that identifies the SUT Specification.
imageName:
type: string
example: elastest/elastest-torm
description: Name of the Docker Image that conteins the SUT (not necessary if the Specification field is filled).
name:
type: string
example: sut definition 1
description: Name of the SUT.
project:
example: '{ id:"1" }'
description: Project to which the SUT is associated
$ref: '#/definitions/Project'
specification:
type: string
example: 'https://github.com/elastest/elastest-torm.git'
description: URL of the GitHub repository where the SUT code is stored (not necessary if the ImageName field is filled)
sutExecution:
type: array
description: List of the SUT Executions of a SUT
items:
$ref: '#/definitions/SutExecution'
tjobs:
type: array
description: List of TJobs associated to a SUT Specification
items:
$ref: '#/definitions/TJob'
description: SUT definition.
ExternalJob:
type: object
required:
- jobName
properties:
analyzerUrl:
type: string
example: 'http://localhost:4200#/logmanager?indexName=8'
description: URL to acces to Log Analyzer in ElasTest.
executionUrl:
type: string
example: 'http://192.168.99.100:8091/#/projects/2/tjob/8'
description: URL to acces to TJob execution in ElasTest.
jobName:
type: string
example: job1
description: Job name on any external system.
logstashPort:
type: string
example: '9200'
description: Port where the Logstash service is listening.
servicesIp:
type: string
example: 192.168.99.100
description: IP where ElasTest services are located.
tJobExecId:
type: integer