-
Notifications
You must be signed in to change notification settings - Fork 30
/
openapi.yaml
4791 lines (4791 loc) · 125 KB
/
openapi.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
---
openapi: 3.0.3
info:
title: Horreum REST API
description: "Horreum automated change anomaly detection. For more information,\
\ please see [https://horreum.hyperfoil.io/](https://horreum.hyperfoil.io/)"
version: "0.14"
tags:
- name: Config
description: Endpoint providing configuration for the Horreum System
x-smallrye-profile-external: ""
- name: Dataset
description: Datasets are used as the basis for all change detection and reporting
x-smallrye-profile-external: ""
- name: Experiment
description: Experiments allow users to apply change detection rules to two different
datasets. This allows for pass/fail of KPIS based on A/B testing
x-smallrye-profile-external: ""
- name: Run
description: Manage test runs. Runs are instances of results of a benchmark execution
x-smallrye-profile-external: ""
- name: Schema
description: Manage schemas
x-smallrye-profile-external: ""
- name: Test
description: Endpoint giving access to tests defined in Horreum.
x-smallrye-profile-external: ""
paths:
/api/config/datastore:
put:
tags:
- Config
description: Update an existing Datastore definition
operationId: updateDatastore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Datastore'
responses:
"200":
description: The ID of the updated Datastore
content:
application/json:
schema:
format: int32
type: integer
post:
tags:
- Config
description: Create a new Datastore
operationId: newDatastore
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Datastore'
responses:
"200":
description: The ID for the new Datastore
content:
application/json:
schema:
format: int32
type: integer
/api/config/datastore/{id}:
delete:
tags:
- Config
description: Test a Datastore
operationId: deleteDatastore
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"204":
description: No Content
/api/config/datastore/{id}/test:
get:
tags:
- Config
description: Test a Datastore connection
operationId: testDatastore
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatastoreTestResponse'
/api/config/datastore/{team}:
get:
tags:
- Config
description: Obtain list of configured datastores for particular team
operationId: datastores
parameters:
- name: team
in: path
description: name of the team to search for defined datastores
required: true
schema:
type: string
example: perf-team
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Datastore'
/api/config/keycloak:
get:
tags:
- Config
description: Obtain configuration information about keycloak server securing
Horreum instance
operationId: keycloak
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/KeycloakConfig'
/api/config/version:
get:
tags:
- Config
description: Obtain version of the running Horreum instance
operationId: version
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VersionInfo'
/api/dataset/bySchema:
get:
tags:
- Dataset
description: "Retrieve a paginated list of Datasets, with total count, by Schema"
operationId: listBySchema
parameters:
- name: uri
in: query
description: Schema URI
required: true
schema:
type: string
example: uri:techempower:0.1
- name: limit
in: query
description: limit the number of results
schema:
format: int32
type: integer
example: 20
- name: page
in: query
description: filter by page number of a paginated list of Schemas
schema:
format: int32
type: integer
example: 2
- name: sort
in: query
description: Field name to sort results
schema:
default: start
type: string
example: name
- name: direction
in: query
description: Sort direction
schema:
$ref: '#/components/schemas/SortDirection'
example: Ascending
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetList'
/api/dataset/list/{testId}:
get:
tags:
- Dataset
description: "Retrieve a paginated list of Datasets, with total count, by Test"
operationId: listByTest
parameters:
- name: testId
in: path
description: Test ID of test to retrieve list of Datasets
required: true
schema:
format: int32
type: integer
example: 101
- name: filter
in: query
description: JOSN Filter expression to apply to query
schema:
type: string
example:
buildID: 111111
- name: limit
in: query
description: limit the number of results
schema:
format: int32
type: integer
example: 20
- name: page
in: query
description: filter by page number of a paginated list of Schemas
schema:
format: int32
type: integer
example: 2
- name: sort
in: query
description: Field name to sort results
schema:
type: string
example: name
- name: direction
in: query
description: Sort direction
schema:
$ref: '#/components/schemas/SortDirection'
example: Ascending
- name: viewId
in: query
description: Optional View ID to filter datasets by view
schema:
format: int32
type: integer
example: 202
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetList'
/api/dataset/{datasetId}/labelValues:
get:
tags:
- Dataset
operationId: labelValues
parameters:
- name: datasetId
in: path
required: true
schema:
format: int32
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LabelValue'
/api/dataset/{datasetId}/previewLabel:
post:
tags:
- Dataset
operationId: previewLabel
parameters:
- name: datasetId
in: path
required: true
schema:
format: int32
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Label'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LabelPreview'
/api/dataset/{datasetId}/summary:
get:
tags:
- Dataset
operationId: getSummary
parameters:
- name: datasetId
in: path
required: true
schema:
format: int32
type: integer
- name: viewId
in: query
schema:
format: int32
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DatasetSummary'
/api/dataset/{id}:
get:
tags:
- Dataset
description: Retrieve Dataset by ID
operationId: getDataset
parameters:
- name: id
in: path
description: Dataset ID to retrieve
required: true
schema:
format: int32
type: integer
example: 101
responses:
"404":
description: No Dataset with the given id was found
content:
application/json: {}
"200":
description: JVM system properties of a particular host.
content:
application/json:
schema:
$ref: '#/components/schemas/Dataset'
/api/experiment/models:
get:
tags:
- Experiment
description: Retrieve a list of Condition Config models
operationId: models
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConditionConfig'
/api/experiment/run:
get:
tags:
- Experiment
description: Run an experiment for a given dataset and experiment profile
operationId: runExperiments
parameters:
- name: datasetId
in: query
description: The dataset to run the experiment on
schema:
format: int32
type: integer
example: 101
responses:
"200":
description: Array of experiment results
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExperimentResult'
/api/experiment/{testId}/profiles:
get:
tags:
- Experiment
description: Retrieve Experiment Profiles by Test ID
operationId: profiles
parameters:
- name: testId
in: path
description: Test ID to retrieve Experiment Profiles for
required: true
schema:
format: int32
type: integer
example: 101
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ExperimentProfile'
post:
tags:
- Experiment
description: 'Save new or update existing Experiment Profiles for a Test '
operationId: addOrUpdateProfile
parameters:
- name: testId
in: path
description: Test ID to retrieve Experiment Profiles for
required: true
schema:
format: int32
type: integer
example: 101
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentProfile'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
format: int32
type: integer
/api/experiment/{testId}/profiles/{profileId}:
delete:
tags:
- Experiment
description: Delete an Experiment Profiles for a Test
operationId: deleteProfile
parameters:
- name: testId
in: path
description: Test ID
required: true
schema:
format: int32
type: integer
example: 101
- name: profileId
in: path
description: Experiment Profile ID
required: true
schema:
format: int32
type: integer
example: 202
responses:
"204":
description: No Content
/api/run/autocomplete:
get:
tags:
- Run
operationId: autocomplete
parameters:
- name: query
in: query
description: JSONPath to be autocompleted
required: true
schema:
type: string
example: $.
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
type: string
/api/run/bySchema:
get:
tags:
- Run
description: Retrieve a paginated list of Runs with available count for a given
Schema URI
operationId: listBySchema
parameters:
- name: uri
in: query
description: Schema URI
required: true
schema:
type: string
example: uri:my-schema:0.1
- name: limit
in: query
description: limit the number of results
schema:
format: int32
type: integer
example: 20
- name: page
in: query
description: filter by page number of a paginated list of Tests
schema:
format: int32
type: integer
example: 2
- name: sort
in: query
description: Field name to sort results
schema:
type: string
example: name
- name: direction
in: query
description: Sort direction
schema:
$ref: '#/components/schemas/SortDirection'
example: Ascending
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RunsSummary'
/api/run/count:
get:
tags:
- Run
description: Run count summary for given Test ID
operationId: runCount
parameters:
- name: testId
in: query
description: Test ID
required: true
schema:
format: int32
type: integer
example: 101
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RunCount'
/api/run/data:
post:
tags:
- Run
description: Upload a new Run
operationId: addRunFromData
parameters:
- name: start
in: query
description: "start timestamp of run, or json path expression"
required: true
schema:
type: string
examples:
scalar value:
value: 2023-10-23T00:13:35Z
json path:
value: $.buildTimeStamp
- name: stop
in: query
description: "stop timestamp of run, or json path expression"
required: true
schema:
type: string
examples:
scalar value:
value: 2023-10-23T00:13:35Z
json path:
value: $.buildTimeStamp
- name: test
in: query
description: test name of ID
required: true
schema:
type: string
example: my-benchmark
- name: owner
in: query
description: Name of the new owner
schema:
type: string
example: perf-team
- name: access
in: query
description: New Access level
schema:
$ref: '#/components/schemas/Access'
example: 0
- name: token
in: query
description: Horreum internal token. Incompatible with Keycloak
schema:
type: string
example: 094678029a2aaf9a2847502273099bb3a1b2338c2b9c618ed09aef0181666e38
- name: schema
in: query
description: Schema URI
schema:
type: string
example: uri:my-benchmark:0.2
- name: description
in: query
description: Run description
schema:
type: string
example: AWS runs
requestBody:
content:
application/json:
schema:
type: string
example:
- tag: main
score: 2031.7424089224041
params:
size: "1000"
useTreeSet: "true"
$schema: urn:jmh:0.2
testName: org.drools.benchmarks.datastructures.QueueBenchmark.benchmark
- $schema: urn:horreum:jenkins-plugin:0.1
jobName: upstream-perf-bre-datastructures
buildUrl: https://qe.com/job/TESTING/job/upstream-perfx-datastructures/125/
startTime: 1698020160763
uploadTime: 1698020592674
buildNumber: 125
jobFullName: TESTING/RHBA/_upstream/decisions/8.x/performance/nightly/upstream-perf-bre-datastructures
scheduleTime: 1698020160756
jobDisplayName: upstream-perf-bre-datastructures
buildDisplayName: '#125'
responses:
"200":
description: id of the newly generated run
content:
application/json:
schema:
format: int32
type: integer
example: 101
"400":
description: Some fields are missing or invalid
content:
application/json: {}
/api/run/list:
get:
tags:
- Run
description: Retrieve a paginated list of Runs with available count
operationId: listAllRuns
parameters:
- name: query
in: query
description: query string to filter runs
schema:
type: string
example: $.*
- name: matchAll
in: query
description: match all Runs?
schema:
type: boolean
example: false
- name: roles
in: query
description: "__my, __all or a comma delimited list of roles"
schema:
type: string
example: __my
- name: trashed
in: query
description: show trashed runs
schema:
type: boolean
example: false
- name: limit
in: query
description: limit the number of results
schema:
format: int32
type: integer
example: 20
- name: page
in: query
description: filter by page number of a paginated list of Tests
schema:
format: int32
type: integer
example: 2
- name: sort
in: query
description: Field name to sort results
schema:
type: string
example: name
- name: direction
in: query
description: Sort direction
schema:
$ref: '#/components/schemas/SortDirection'
example: Ascending
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RunsSummary'
/api/run/list/{testId}:
get:
tags:
- Run
description: Retrieve a paginated list of Runs with available count for a given
Test ID
operationId: listTestRuns
parameters:
- name: testId
in: path
description: Test ID
required: true
schema:
format: int32
type: integer
example: 101
- name: trashed
in: query
description: include trashed runs
schema:
type: boolean
example: false
- name: limit
in: query
description: limit the number of results
schema:
format: int32
type: integer
example: 20
- name: page
in: query
description: filter by page number of a paginated list of Tests
schema:
format: int32
type: integer
example: 2
- name: sort
in: query
description: Field name to sort results
schema:
type: string
example: name
- name: direction
in: query
description: Sort direction
schema:
$ref: '#/components/schemas/SortDirection'
example: Ascending
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RunsSummary'
/api/run/recalculateAll:
post:
tags:
- Run
description: Recalculate Datasets for Runs between two dates
operationId: recalculateAll
parameters:
- name: from
in: query
description: start timestamp
schema:
type: string
example: 1698013206000
- name: to
in: query
description: end timestamp
schema:
type: string
example: 1698013206000
responses:
"201":
description: Created
/api/run/test:
post:
tags:
- Run
description: Upload a new Run
operationId: add
parameters:
- name: test
in: query
description: test name of ID
schema:
type: string
example: my-benchmark
- name: owner
in: query
description: Name of the new owner
schema:
type: string
example: perf-team
- name: access
in: query
description: New Access level
schema:
$ref: '#/components/schemas/Access'
example: 0
- name: token
in: query
description: API token
schema:
type: string
example: 094678029a2aaf9a2847502273099bb3a1b2338c2b9c618ed09aef0181666e38
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Run'
required: true
responses:
"200":
description: OK
/api/run/{id}:
get:
tags:
- Run
description: Get extended Run information by Run ID
operationId: getRun
parameters:
- name: id
in: path
description: Run ID
required: true
schema:
format: int32
type: integer
example: 202
- name: token
in: query
description: Run API token
schema:
type: string
example: 094678029a2aaf9a2847502273099bb3a1b2338c2b9c618ed09aef0181666e38
responses:
"404":
description: If no Run have been found with the given id
content:
application/json: {}
"200":
description: Run data with the referenced schemas and generated datasets
content:
application/json:
schema:
$ref: '#/components/schemas/RunExtended'
/api/run/{id}/data:
get:
tags:
- Run
description: Get Run data by Run ID
operationId: getData
parameters:
- name: id
in: path
description: Run ID
required: true
schema:
format: int32
type: integer
example: 202
- name: token
in: query
description: Run API token
schema:
type: string
example: 094678029a2aaf9a2847502273099bb3a1b2338c2b9c618ed09aef0181666e38
- name: schemaUri
in: query
description: FIlter by Schmea URI
schema:
type: string
example: uri:my-benchmark:0.1
responses:
"200":
description: Run payload
content:
application/json:
schema:
type: object
example: "{ \"buildID\": 1709, ...}"
/api/run/{id}/description:
post:
tags:
- Run
description: Update Run description
operationId: updateDescription
parameters:
- name: id
in: path
description: Run ID
required: true
schema:
format: int32
type: integer
example: 101
requestBody:
content:
text/plain:
schema:
type: string
required: true
responses:
"201":
description: Created
/api/run/{id}/dropToken:
post:
tags:
- Run
description: Remove access token for Run
operationId: dropToken
parameters:
- name: id
in: path
description: Token ID
required: true
schema:
format: int32
type: integer
example: 102
responses:
"200":
description: OK
content:
application/json:
schema:
type: string
/api/run/{id}/labelValues:
get:
tags:
- Run
description: Get all the label values for the run
operationId: labelValues
parameters:
- name: id
in: path
description: Run Id
required: true
schema:
format: int32
type: integer
example: 101
- name: filter
in: query
description: either a required json sub-document or path expression
schema:
default: "{}"
type: string
examples:
object:
description: json object that must exist in the values object
value: "{labelName:necessaryValue,...}"
string:
description: valid filtering jsonpath that returns null if not found (not
predicates)
value: $.count ? (@ < 20 && @ > 10)
- name: sort
in: query
description: label name for sorting
schema:
default: ""
type: string
- name: direction
in: query
description: either Ascending or Descending
schema:
default: Ascending
type: string