forked from NixOS/hydra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hydra-api.yaml
1112 lines (1071 loc) · 32.7 KB
/
hydra-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
openapi: "3.0.0"
info:
version: 1.0.0
title: Hydra API
description: Specification of the Hydra REST API
servers:
- url: https://hydra.nixos.org
paths:
/login:
post:
summary: Log in using username/password credentials
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
description: user
type: string
password:
description: password
type: string
responses:
'200':
description: successful login
content:
application/json:
schema:
type: object
properties:
username:
description: user
type: string
fullname:
description: full name
type: string
emailaddress:
description: email
type: string
userroles:
description: user roles
type: array
items:
type: string
'403':
description: login failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/:
get:
summary: Retrieves all projects
description: Retrieves a list of all projects.
responses:
'200':
description: List of all configured projects
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
examples:
projects-success:
$ref: '#/components/examples/projects-success'
/api/push:
put:
summary: trigger jobsets
parameters:
- in: query
name: jobsets
description: project and jobset formatted as "<project>:<jobset>" to evaluate
schema:
type: string
responses:
'200':
description: jobset trigger response
content:
application/json:
schema:
type: object
properties:
jobsetsTriggered:
type: array
items:
type: string
/api/jobsets:
get:
summary: retrieve a jobset overview for a project
parameters:
- in: query
name: project
description: name of the project
schema:
type: string
responses:
'200':
description: jobset overview
content:
application/json:
schema:
$ref: '#/components/schemas/JobsetOverview'
'404':
description: project could not be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/search:
get:
summary: search for evaluations
description: search for evaluations by name
parameters:
- in: query
name: query
schema:
type: string
description: string to search for
responses:
'200':
description: search response
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResult'
'500':
description: Empty search term or other internal error
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: error message
/project/{id}:
put:
summary: Create a project
parameters:
- name: id
in: path
description: project identifier
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: name of the project
type: string
displayname:
description: display name of the project
type: string
description:
description: description of the project
type: string
homepage:
description: homepage of the project
type: string
owner:
description: owner of the project
type: string
enabled:
description: when set to true the project gets scheduled for evaluation
type: boolean
enable_dynamic_run_command:
description: when true the project's jobsets support executing dynamically defined RunCommand hooks. Requires the server and project's configuration to also enable dynamic RunCommand.
type: boolean
visible:
description: when set to true the project is displayed in the web interface
type: boolean
declarative:
description: declarative input configured for this project
type: object
$ref: '#/components/schemas/DeclarativeInput'
responses:
'400':
description: bad request
content:
application/json:
schema:
type: object
properties:
error:
description: error message
type: string
'403':
description: request unauthorized
content:
application/json:
schema:
type: object
properties:
error:
description: error message
type: string
'200':
description: projects exists
content:
application/json:
schema:
type: object
properties:
redirect:
description: URL of the created project
type: string
'201':
description: successful project creation
content:
application/json:
schema:
type: object
properties:
uri:
description: URL of the created project
type: string
name:
description: name of the project
type: string
redirect:
description: URL of the created project
type: string
type:
description: type of the created resource ("project")
type: string
get:
summary: Retrieves a project designated by name
parameters:
- name: id
in: path
description: project identifier
required: true
schema:
type: string
responses:
'200':
description: project response
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
examples:
project-success:
$ref: '#/components/examples/project-success'
'404':
description: project could not be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Deletes a project
parameters:
- name: id
in: path
description: project identifier
required: true
schema:
type: string
responses:
'200':
description: project deleted
content:
application/json:
schema:
type: object
properties:
redirect:
type: string
description: root of the Hydra instance
'404':
description: project could not be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/jobset/{project-id}/{jobset-id}:
put:
summary: Creates a jobset in an existing project
parameters:
- name: project-id
required: true
in: path
description: name of the project to create the jobset in
schema:
type: string
- name: jobset-id
required: true
in: path
description: name of the jobset to create
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Jobset'
responses:
'201':
description: jobset creation response
content:
application/json:
schema:
type: object
properties:
redirect:
type: string
description: url pointing to the webui for the created jobset
uri:
type: string
description: url to the created jobset
name:
type: string
description: name of the created jobset
'type':
type: string
description: Set to "jobset"
'200':
description: jobset creation response when jobset exists already
content:
application/json:
schema:
type: object
properties:
redirect:
type: string
description: url pointing to the webui for the created jobset
get:
summary: Retrieves a jobset designated by project and jobset id
parameters:
- name: project-id
in: path
description: name of the project the jobset belongs to
required: true
schema:
type: string
- name: jobset-id
in: path
description: name of the jobset to retrieve
required: true
schema:
type: string
responses:
'200':
description: jobset response
content:
application/json:
schema:
$ref: '#/components/schemas/Jobset'
examples:
jobset-success:
$ref: '#/components/examples/jobset-success'
'404':
description: jobset couldn't be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
summary: Deletes a jobset designated by project and jobset id
parameters:
- name: project-id
in: path
description: name of the project the jobset belongs to
required: true
schema:
type: string
- name: jobset-id
in: path
description: name of the jobset to retrieve
required: true
schema:
type: string
responses:
'200':
description: jobset successfully deleted
content:
application/json:
schema:
type: object
properties:
redirect:
type: string
description: root of the Hydra instance
'404':
description: jobset couldn't be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/jobset/{project-id}/{jobset-id}/evals:
get:
summary: Retrieves all evaluations of a jobset
parameters:
- name: project-id
in: path
description: project identifier
required: true
schema:
type: string
- name: jobset-id
in: path
description: jobset identifier
required: true
schema:
type: string
responses:
'200':
description: evaluations
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Evaluations'
examples:
evals-success:
$ref: '#/components/examples/evals-success'
'404':
description: jobset couldn't be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/job/{project-id}/{jobset-id}/{job-id}/shield:
get:
summary: Generate data for a shields.io badge
parameters:
- name: project-id
in: path
description: project identifier
required: true
schema:
type: string
- name: jobset-id
in: path
description: jobset identifier
required: true
schema:
type: string
- name: job-id
in: path
description: job identifier
required: true
schema:
type: string
responses:
'200':
description: see <a href="https://shields.io/endpoint">https://shields.io/endpoint</a> on how to use this
content:
application/json:
examples:
shield-success:
value:
color: green
schemaVersion: 1
label: hydra build
message: passing
/build/{build-id}:
get:
summary: Retrieves a single build of a jobset by id
parameters:
- name: build-id
in: path
description: build identifier
required: true
schema:
type: integer
responses:
'200':
description: build
content:
application/json:
schema:
$ref: '#/components/schemas/Build'
examples:
build-success:
$ref: '#/components/examples/build-success'
'404':
description: build couldn't be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/build/{build-id}/constituents:
get:
summary: Retrieves a build's constituent jobs
parameters:
- name: build-id
in: path
description: build identifier
required: true
schema:
type: integer
responses:
'200':
description: build
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Build'
'404':
description: build couldn't be found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/eval/{build-id}:
get:
summary: Retrieves evaluations identified by build id
parameters:
- name: build-id
in: path
description: build identifier
required: true
schema:
type: integer
responses:
'200':
description: evaluation
content:
application/json:
schema:
$ref: '#/components/schemas/JobsetEval'
components:
schemas:
SearchResult:
type: object
properties:
jobsets:
description: jobsets matching search term
type: array
items:
$ref: '#/components/schemas/Jobset'
projects:
description: projects missing search term
type: array
items:
$ref: '#/components/schemas/Project'
builds:
description: builds matching search term
type: array
items:
$ref: '#/components/schemas/Build'
buildsdrv:
description: derivations matching search term
type: array
items:
$ref: '#/components/schemas/Build'
Error:
type: object
properties:
error:
description: error message
type: string
Project:
type: object
properties:
owner:
description: username of the project owner
type: string
name:
description: name of the project
type: string
displayname:
description: name to be displayed in the web interface
type: string
description:
description: description of the project
type: string
homepage:
description: homepage of the project
type: string
hidden:
description: when set to true the project is not displayed in the web interface
type: boolean
enabled:
description: when set to true the project gets scheduled for evaluation
type: boolean
enable_dynamic_run_command:
description: when true the project's jobsets support executing dynamically defined RunCommand hooks. Requires the server and project's configuration to also enable dynamic RunCommand.
type: boolean
declarative:
description: declarative input configured for this project
type: object
$ref: '#/components/schemas/DeclarativeInput'
jobsets:
description: list of jobsets belonging to this project
type: array
items:
type: string
DeclarativeInput:
type: object
properties:
file:
description: The file in `value` which contains the declarative spec file. Relative to the root of `value`.
type: string
type:
description: The type of the declarative input.
type: string
value:
description: The value of the declarative input.
type: string
JobsetInput:
type: object
properties:
name:
description: name of the input
type: string
value:
description: value of the input
type: string
type:
description: type of input
type: string
emailresponsible:
description: whether or not to email responsible parties
type: boolean
Jobset:
type: object
properties:
name:
description: the name of the jobset
type: string
project:
description: the project this jobset belongs to
type: string
description:
nullable: true
description: a description of the jobset
type: string
nixexprinput:
nullable: true
description: the name of the jobset input which contains the nixexprpath
type: string
nixexprpath:
nullable: true
description: the path to the file to evaluate
type: string
errormsg:
nullable: true
description: contains the stderr output of the nix-instantiate command
type: string
errortime:
nullable: true
description: timestamp associated with errormsg
type: integer
lastcheckedtime:
nullable: true
description: the last time the evaluator looked at this jobset
type: integer
triggertime:
nullable: true
description: set to the time we were triggered by a push event
type: integer
enabled:
description: 0 is disabled, 1 is enabled, 2 is one-shot, and 3 is one-at-a-time
type: integer
enableemail:
description: when true the jobset sends emails when previously-successful builds fail
type: boolean
enable_dynamic_run_command:
description: when true the jobset supports executing dynamically defined RunCommand hooks. Requires the server and project's configuration to also enable dynamic RunCommand.
type: boolean
visible:
description: when true the jobset is visible in the web frontend
type: boolean
emailoverride:
description: email address to send notices to instead of the package maintainer (can be a comma separated list)
type: string
keepnr:
description: number or evaluations to keep
type: integer
checkinterval:
description: interval (in seconds) in which to check for evaluation
type: integer
schedulingshares:
description: how many shares to be allocated to the jobset
type: integer
fetcherrormsg:
nullable: true
description: contains the error message when there was a problem fetching sources for a jobset
type: string
startime:
nullable: true
description: set to the time the latest evaluation started (if one is currently running)
type: integer
type:
description: the type of the jobset
type: integer
flake:
nullable: true
description: the flake uri to evaluate
type: string
inputs:
description: inputs configured for this jobset
type: object
additionalProperties:
$ref: '#/components/schemas/JobsetInput'
JobsetEvalInput:
type: object
properties:
uri:
nullable: true
description: URI of this input (which differs depending on the type of the input)
type: string
'type':
description: The type of this input
type: string
revision:
nullable: true
description: A Git/Mercurial commit hash or a Subversion revision number.
type: string
value:
nullable: true
description: A value that corresponds to the type of input
oneOf:
- type: boolean
- type: string
- type: array
items:
type: string
type: boolean
dependency:
nullable: true
description: >
**Deprecated**: The build id of another build
type: string
JobsetEval:
type: object
properties:
id:
type: integer
timestamp:
description: Time in seconds since the Unix epoch when this evaluation was created.
type: integer
checkouttime:
description: How long it took (in seconds) to fetch the jobset inputs.
type: integer
evaltime:
description: How long it took (in seconds) to evaluate the jobset.
type: integer
hasnewbuilds:
description: Whether the number of JobsetEval members is different from the prior evaluation. This is always true on the first evaluation.
type: boolean
flake:
description: For flake jobsets, the immutable flake reference allowing you to reproduce this evaluation. Null otherwise.
nullable: true
type: string
builds:
description: List of builds generated for this jobset evaluation.
type: array
items:
type: integer
jobsetevalinputs:
type: object
additionalProperties:
$ref: '#/components/schemas/JobsetEvalInput'
JobsetOverview:
type: array
items:
type: object
properties:
name:
description: name of the jobset
type: string
project:
description: name of the project
type: string
nrtotal:
description: number of evaluations
type: integer
checkinterval:
description: interval in seconds at which to check the jobset inputs
type: integer
haserrormsg:
description: true if the evaluation had errors
type: boolean
nrscheduled:
description: number of scheduled evaluations
type: integer
nrfailed:
description: number of failed evaluations
type: integer
errortime:
description: time an error occurred during evaluation (unix time stamp)
type: integer
fetcherrormsg:
nullable: true
description: contains the error message when there was a problem fetching sources for a jobset
starttime:
nullable: true
description: time when build started
type: integer
lastcheckedtime:
description: the last time the jobset inputs where checked to see if an evaluation needs to be scheduled (unix time stamp)
type: integer
triggertime:
nullable: true
description: time of the last evaluation trigger for this jobset (unix time stamp)
type: integer
Evaluations:
type: object
properties:
first:
description: first list of results
type: string
next:
description: next list of results
type: string
last:
description: last list of results
type: string
evals:
type: array
description: List of evaluations
items:
type: object
additionalProperties:
$ref: '#/components/schemas/JobsetEval'
BuildProduct:
type: object
properties:
filesize:
nullable: true
description: Size of the produced file
type: integer
defaultpath:
description: This is a Git/Mercurial commit hash or a Subversion revision number
type: string
'type':
description: Types of build product (user defined)
type: string
name:
description: Name of the file
type: string
path:
description: the nix store path
type: string
subtype:
description: user-specified
type: string
sha256hash:
nullable: true
description: sha256 hash of the file
type: string
BuildOutput:
type: object
properties:
path:
description: The nix store path
type: string
Build:
type: object
properties:
id:
type: integer
starttime:
description: time when build started
type: integer
stoptime:
description: time when build ended
type: integer
timestamp:
description: time when the build was first created
type: integer
jobsetevals:
description: list of evaluations this build is part of
type: array
items:
type: integer
finished:
description: true when the build is finished
type: boolean
nixname:
description: name from the build's derivation
type: string
buildstatus:
nullable: true # should only be null if finished is false
description: |
Indicates the build status:</br>
<ul>
<li>0 : succeeded</li>
<li>1 : failed</li>
<li>2 : dependency failed</li>
<li>3 : aborted</li>
<li>4 : canceled by the user</li>
<li>6 : failed with output</li>
<li>7 : timed out</li>
<li>9 : aborted</li>
<li>10 : log size limit exceeded</li>
<li>11 : output size limit exceeded</li>
<li>* : failed</li>
</ul>
<strong>Note:</strong>buildstatus should only be `null` if `finished` is false.
type: integer
jobset:
description: jobset this build belongs to
type: string
priority:
description: determines the priority with which this build will be executed (higher value means higher priority)
type: integer
job:
description: nix attribute from the nixexprpath
type: string
drvpath:
description: filename of the drv
type: string
system:
description: system this build was done for
type: string
project:
description: project this build belongs to
type: string
buildproducts:
type: object
additionalProperties:
$ref: '#/components/schemas/BuildProduct'
buildoutputs:
type: object
additionalProperties:
$ref: '#/components/schemas/BuildOutput'
buildmetrics:
description: |
user defined build metrics from `$out/nix-support/hydra-metrics`. The file should
define metrics separated by new lines using the following format:
```
<name> <value>[ <unit>]
```
The name and unit fields are strings, the value is a float. The unit is optional.
type: object
properties:
name:
type: string
description: name of the measured build metric
value:
type: string
description: measured value
unit:
type: string
description: unit of the measured build metric
examples:
projects-success:
value:
- displayname: Foo Bar
description: Foo Bar Baz Qux
enabled: true
owner: alice
jobsets:
- bar-jobset
hidden: false
homepage: https://example.com/