forked from spotify/styx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.apib
868 lines (710 loc) · 25.9 KB
/
api.apib
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
# Styx API specification
This document is written using [api-blueprint]
## Usage
1. install [dredd]: `npm install -g dredd`
1. package project: `mvn package`
1. run tests: `styx-api-service/bin/api-test.sh`
To generate an html version of this spec, use [aglio]
```
aglio -i doc/api.apib -o api.html --theme-template triple --theme-variables streak
```
[api-blueprint]: https://apiblueprint.org/
[dredd]: https://github.com/apiaryio/dredd
[aglio]: https://github.com/danielgtaylor/aglio
## Authentication
Starting from V3, any request except `GET` requires Google Authentication.
HTTP header `Authorization: Bearer <id_token>` with a valid Google ID token is required
in those requests.
To know more details, please check
[Google documentation](https://developers.google.com/identity/sign-in/web/backend-auth).
# Group Workflows
Resources related to the Workflows registered in Styx.
## Workflows [/{version}/workflows]
### Get Workflows [GET]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ Response 200 (application/json)
[{
"component_id": "styx-canary",
"workflow_id": "StyxCanary",
"component_uri": "file:///etc/styx/schedule.yaml",
"configuration": {
"id": "StyxCanary",
"schedule": "hours",
"offset": null,
"docker_image": null,
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_termination_logging": false,
"env": {"FOO": "bar"},
"secret": null,
"resources": []
}
}]
## Workflows [/{version}/workflows/{component_id}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
### Get Workflows for component [GET]
+ Response 200 (application/json)
[{
"component_id": "styx-canary",
"workflow_id": "StyxCanary",
"component_uri": "file:///etc/styx/schedule.yaml",
"configuration": {
"id": "StyxCanary",
"schedule": "hours",
"offset": null,
"docker_image": null,
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_termination_logging": false,
"env": {"FOO": "bar"},
"secret": null,
"resources": []
}
}]
### Create or update Workflow [POST]
Accepts a Workflow definition as a JSON object. Returns 200 OK if the Workflow was registered
or updated. Note that a non-null value is required for docker_image.
+ Request (application/json)
{
"id": "StyxCanary",
"schedule": "days",
"offset": null,
"docker_image": "styx-canary-dummy:dummy",
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_termination_logging": false,
"env": {"FOO": "bar"},
"secret": null,
"service_account": null,
"resources": []
}
+ Response 200 (application/json)
{
"component_id": "styx-canary",
"workflow_id": "StyxCanary",
"component_uri": "file:///etc/styx/schedule.yaml",
"configuration": {
"id": "StyxCanary",
"schedule": "days",
"offset": null,
"docker_image": "styx-canary-dummy:dummy",
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_termination_logging": false,
"env": {"FOO": "bar"},
"secret": null,
"service_account": null,
"resources": []
},
"__from_api": "V3"
}
## Workflow [/{version}/workflows/{component_id}/{workflow_id}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
+ workflow_id: `StyxCanary` (string) - Workflow ID
### Get Workflow [GET]
+ Response 200 (application/json)
{
"component_id": "styx-canary",
"workflow_id": "StyxCanary",
"component_uri": "file:///etc/styx/schedule.yaml",
"configuration": {
"id": "StyxCanary",
"schedule": "hours",
"offset": null,
"docker_image": null,
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_termination_logging": false,
"env": {"FOO": "bar"},
"secret": null,
"resources": []
}
}
### Delete Workflow [DELETE]
Returns 204 No Content if the Workflow was found and deleted, 404 Not Found otherwise.
+ Response 204
+ Response 404
## Workflow Instances [/{version}/workflows/{component_id}/{workflow_id}/instances{?offset,limit,tail,start,stop}]
Query can be done in three different styles: `offset+limit`, `start+stop` or `tail+limit`.
By using `offset` and `limit`, the oldest workflow instances is specified by `offset`, and
the max number of workflows instances is specified by `limit`.
By using `start` and `stop`, the oldest workflow instance is specified by `start`, and the latest is
specified by `stop`; `start` is required while `stop` is optional.
When using `tail` and `limit`, the newest (naturally triggered) instances are returned. The maxium number of instances
returned is specified by `limit` but fewer instances may be returned even though more instances exist.
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
+ workflow_id: `StyxCanary` (string) - Workflow ID
+ offset: `2017-01-01` (string) - the offset parameter
+ limit: `10` (number) - max number of instances
+ start: `2017-01-01` (string) - the start parameter
+ stop: `2017-01-03` (string) - the stop parameter (exclusive)
+ tail: `true` (optional, boolean) - Return the newest workflow instances?
### Get Workflow Instances [GET]
+ Response 200 (application/json)
[{
"workflow_instance": {
"workflow": {
"component_id": "styx-canary",
"id": "StyxCanary"
},
"parameter": "2016-07-13T08"
},
"triggers": [{
"trigger_id": "UNKNOWN",
"timestamp": "2016-07-13T09:00:23.941Z",
"complete": true,
"executions": [{
"execution_id": "styx-run-qcp3r",
"docker_image": "UNKNOWN",
"statuses": [
{
"timestamp": "2016-07-13T09:00:45.882Z",
"status": "SUBMITTED"
},
{
"timestamp": "2016-07-13T09:00:49.076Z",
"status": "STARTED"
},
{
"timestamp": "2016-07-13T09:00:49.313Z",
"status": "SUCCESS"
}
]
}]
}]
}]
## Workflow Instance [/{version}/workflows/{component_id}/{workflow_id}/instances/{instance}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
+ workflow_id: `StyxCanary` (string) - Workflow ID
+ instance: `2016-07-13T08` (string) - Worfklow Instance parameter
### Get Workflow Instance [GET]
+ Response 200 (application/json)
{
"workflow_instance": {
"workflow": {
"component_id": "styx-canary",
"id": "StyxCanary"
},
"parameter": "2016-07-13T08"
},
"triggers": [{
"trigger_id": "UNKNOWN",
"timestamp": "2016-07-13T09:00:23.941Z",
"complete": true,
"executions": [{
"execution_id": "styx-run-qcp3r",
"docker_image": "UNKNOWN",
"statuses": [
{
"timestamp": "2016-07-13T09:00:45.882Z",
"status": "SUBMITTED"
},
{
"timestamp": "2016-07-13T09:00:49.076Z",
"status": "STARTED"
},
{
"timestamp": "2016-07-13T09:00:49.313Z",
"status": "SUCCESS"
}
]
}]
}]
}
## Workflow state [/{version}/workflows/{component_id}/{workflow_id}/state]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
+ workflow_id: `StyxCanary` (string) - Workflow ID
### Get Workflow state [GET]
+ Response 200 (application/json)
{
"enabled": "true",
"docker_image": "styx-canary-dummy:dummy",
"commit_sha": "f043333085fa87738ac24f04d64fb58ecc845111",
"next_natural_trigger": "2017-01-01T01:00:00Z",
"next_natural_offset_trigger": "2017-01-01T02:00:00Z"
}
### Set Workflow state [PATCH]
+ Request (application/json)
{
"enabled": "false",
"next_natural_trigger": "2017-01-01T01:00:00Z",
"next_natural_offset_trigger": "2017-01-01T02:00:00Z"
}
+ Response 200 (application/json)
{
"enabled": "false",
"docker_image": "styx-canary-dummy:dummy",
"commit_sha": "f043333085fa87738ac24f04d64fb58ecc845111",
"next_natural_trigger": "2017-01-01T01:00:00Z",
"next_natural_offset_trigger": "2017-01-01T02:00:00Z"
}
# Group Resources
Resources related to Styx Resources registered in the scheduler. Styx Resources
can be used to limit the maximum concurrent executions for certain Workflows.
## Resources [/{version}/resources]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Get Resources [GET]
+ Response 200 (application/json)
{
"resources": [{
"concurrency": 20,
"id": "styx-canary-resource"
}]
}
### Create Resource [POST]
+ Request (application/json)
{
"concurrency": "20",
"id": "styx-canary-resource"
}
+ Response 200 (application/json)
{
"concurrency": 20,
"id": "styx-canary-resource"
}
## Resource [/{version}/resources/{resource}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ resource: `styx-canary-resource` (string) - Resource ID
### Get Resource [GET]
+ Response 200 (application/json)
{
"resources": [{
"concurrency": 20,
"id": "styx-canary-resource"
}]
}
### Delete Resource [DELETE]
+ Response 204
### Modify Resource [PUT]
+ Request (application/json)
{
"concurrency": "30",
"id": "styx-canary-resource"
}
+ Response 200 (application/json)
{
"concurrency": 30,
"id": "styx-canary-resource"
}
# Group Backfills
Resources related to the Backfills in Styx. This group allows to operate on
Backfill entities registered in Styx and check detailed status of each single
Workflow Instance belonging to a Backfill entity.
## Backfills [/{version}/backfills{?component,workflow,status,showAll,allowFuture}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Get Backfills [GET]
+ Parameters
+ component: `styx-canary` (optional, string) - Workflow Component to filter with
+ workflow: `StyxCanary` (optional, string) - Workflow ID to filter with
+ status: `true` (optional, boolean) - If to return the status list per backfill
+ Default: false
+ showAll: `true` (optional, boolean) - If to return also halted backfills and backfills whose instances have been all triggered
+ Default: false
+ Response 200 (application/json)
{
"backfills": [{
"backfill": {
"all_triggered": true,
"concurrency": 10,
"end": "2017-01-01T01:00:00Z",
"halted": false,
"id": "backfill-1489054446085-53384",
"next_trigger": "2017-01-01T01:00:00Z",
"schedule": "hours",
"start": "2017-01-01T00:00:00Z",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
},
"statuses": {
"active_states": [{
"initial_timestamp": 1536838486145,
"latest_timestamp": 1536838486185,
"state": "DONE",
"state_data": {
"consecutive_failures": 0,
"execution_description": {
"commit_sha": "f043333085fa87738ac24f04d64fb58ecc845111",
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_image": "styx-canary-dummy:dummy",
"docker_termination_logging": false,
"secret": null
},
"execution_id": "styx-run-6b1962c6-23ba-4245-a13b-ec3baa4b2133",
"last_exit": 0,
"messages": [
{
"level": "INFO",
"line": "Exit code: 0"
}
],
"retry_cost": 0.0,
"retry_delay_millis": null,
"tries": 1,
"trigger": {
"@type": "backfill",
"trigger_id": "backfill-1489054446085-53384"
},
"trigger_id": "backfill-1489054446085-53384"
},
"workflow_instance": {
"parameter": "2017-01-01T00",
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
}]
}
}]
}
### Create Backfill [POST]
+ Parameters
+ allowFuture: `false` (optional, boolean) - allow backfilling future partitions
+ Default: false
+ Request (application/json)
{
"start": "2017-01-01T00:00:00Z",
"end": "2017-01-02T00:00:00Z",
"component": "styx-canary",
"concurrency": "10",
"description": "fixed bug and reproduce data",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow": "StyxCanary",
}
+ Response 200 (application/json)
{
"all_triggered": false,
"concurrency": 10,
"end": "2017-02-00T00:00:00Z",
"description": "fixed bug and reproduce data",
"halted": false,
"id": "backfill-1489054446085-52684",
"next_trigger": "2017-01-01T00:00:00Z",
"schedule": "hours",
"start": "2017-01-01T00:00:00Z",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
## Backfill [/{version}/backfills/{backfill_id}{?status}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ backfill_id: `backfill-1489054446085-52684` (string) - Backfill ID
### Get Backfill [GET]
+ Parameters
+ status: `true` (optional, boolean) - If to return the status list per backfill
+ Default: true
+ Response 200 (application/json)
{
"backfill": {
"all_triggered": true,
"concurrency": 10,
"description": "fixed bug and reproduce data",
"end": "2017-01-01T01:00:00Z",
"halted": false,
"id": "backfill-1489054446085-53384",
"next_trigger": "2017-01-01T01:00:00Z",
"schedule": "hours",
"start": "2017-01-01T00:00:00Z",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
},
"statuses": {
"active_states": [{
"initial_timestamp": 1536838486145,
"latest_timestamp": 1536838486185,
"state": "DONE",
"state_data": {
"consecutive_failures": 0,
"execution_description": {
"commit_sha": "f043333085fa87738ac24f04d64fb58ecc845111",
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_image": "styx-canary-dummy:dummy",
"docker_termination_logging": false,
"secret": null
},
"execution_id": "styx-run-6b1962c6-23ba-4245-a13b-ec3baa4b2133",
"last_exit": 0,
"messages": [
{
"level": "INFO",
"line": "Exit code: 0"
}
],
"retry_cost": 0.0,
"retry_delay_millis": null,
"tries": 1,
"trigger": {
"@type": "backfill",
"trigger_id": "backfill-1489054446085-53384"
},
"trigger_id": "backfill-1489054446085-53384"
},
"workflow_instance": {
"parameter": "2017-01-01T00",
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
}]
}
}
### Modify Backfill [PUT]
+ Request (application/json)
{
"concurrency": 20,
"description": "fixed bug and reproduce data",
"id": "backfill-1489054446085-52684",
}
+ Response 200 (application/json)
{
"all_triggered": false,
"concurrency": 20,
"end": "2017-02-00T00:00:00Z",
"description": "fixed bug and reproduce data",
"halted": false,
"id": "backfill-1489054446085-52684",
"next_trigger": "2017-01-01T00:00:00Z",
"schedule": "hours",
"start": "2017-01-01T00:00:00Z",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
### Delete Backfill [DELETE]
+ Response 200
# Group Status
Resources related to inspect detailed status of Workflow Instances.
## Active States [/{version}/status/activeStates]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Get Active States [GET]
+ Response 200 (application/json)
{
"active_states": [{
"latest_timestamp": 1536838486185,
"state": "RUNNING",
"state_data": {
"consecutive_failures": 0,
"execution_description": {
"commit_sha": "f043333085fa87738ac24f04d64fb58ecc845111",
"docker_args": [
"luigi",
"--module",
"canary_job",
"CanaryJob"
],
"docker_image": "styx-canary-dummy:dummy",
"docker_termination_logging": false,
"secret": null
},
"execution_id": "styx-run-6b1962c6-23ba-4245-a13b-ec3baa4b21d5",
"last_exit": 20,
"messages": [
{
"level": "WARNING",
"line": "Exit code: 20"
}
],
"retry_cost": 0.2,
"retry_delay_millis": 600000,
"tries": 2,
"trigger": {
"@type": "natural"
},
"trigger_id": "natural-trigger"
},
"workflow_instance": {
"parameter": "2017-01-01T01",
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
}]
}
## Events [/{version}/status/events/{component_id}/{workflow_id}/{instance}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ component_id: `styx-canary` (string) - Workflow Component
+ workflow_id: `StyxCanary` (string) - Workflow ID
+ instance: `2017-01-01T01` (string) - Worfklow Instance parameter
### Get Workflow Instance events [GET]
+ Response 200 (application/json)
{
"events": [{
"event": {
"@type": "triggerExecution",
"trigger": {
"@type": "natural"
},
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01",
"parameters": {"env": {"FOO": "bar"}}
},
"timestamp": 1483228800000
},
{
"event": {
"@type": "dequeue",
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01"
},
"timestamp": 1483228800005
}]
}
# Group Scheduler
Resources related to operations that act on the current state of the scheduler.
## Retry [/{version}/scheduler/retry{?delay}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Send Retry [POST]
+ Parameters
+ delay: `0` (optional, long) - The new delay value to set for the workflow instance
+ Default: 0
+ Request (application/json)
{
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01"
}
+ Response 200 (application/json)
{
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01"
}
## Halt [/{version}/scheduler/halt]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Send Halt [POST]
+ Request (application/json)
{
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01"
}
+ Response 200 (application/json)
{
"workflow_instance": "styx-canary/StyxCanary/2017-01-01T01"
}
## Trigger [/{version}/scheduler/trigger{?allowFuture}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
+ allowFuture: `false` (optional, boolean) - allow triggering future partition
+ Default: false
### Trigger Workflow Instance [POST]
+ Request (application/json)
{
"parameter": "2017-01-01T01",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
+ Response 200 (application/json)
{
"parameter": "2017-01-01T01",
"trigger_parameters": {"env": {"FOO": "bar"}},
"workflow_id": {
"component_id": "styx-canary",
"id": "StyxCanary"
}
}
# Group Styx Config
Resources related to global configurations for Styx.
## Global Enabled [/{version}/config{?enabled}]
+ Parameters
+ version: `v3` (enum[string]) - API version
+ Members
+ `v3`
### Get Global Enabled [GET]
+ Response 200 (application/json)
{
"enabled": "true"
}
### Set Global Enabled [POST]
+ Parameters
+ enabled: `true` (required, boolean) - Global enabled value
+ Response 200 (application/json)
{
"enabled": "true"
}