-
Notifications
You must be signed in to change notification settings - Fork 38
/
workflow_execution_service.openapi.yaml
984 lines (935 loc) · 38.6 KB
/
workflow_execution_service.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
openapi: 3.0.0
info:
title: Workflow Execution Service
contact: {}
version: '1.1.0'
x-logo:
url: 'https://www.ga4gh.org/wp-content/themes/ga4gh-theme/gfx/GA-logo-horizontal-tag-RGB.svg'
description: >
*Run standard workflows on workflow execution platforms in a platform-agnostic way.*
## Executive Summary
The Workflow Execution Service (WES) API provides a standard way for users to submit workflow requests to workflow execution systems, and to monitor their execution. This API lets users run a single workflow (currently [**CWL**](https://www.commonwl.org/) or [**WDL**](http://www.openwdl.org/) formatted workflows, other types may be supported in the future) on multiple different platforms, clouds, and environments.
Key features of the API:
+ can request that a workflow be run
+ can pass parameters to that workflow (e.g. input files, cmdline arguments)
+ can get information about running workflows (e.g. status, errors, output file locations)
+ can cancel a running workflow
servers:
- url: https://{defaultHost}/{basePath}/{apiVersion}
variables:
defaultHost:
default: www.example.com
basePath:
default: ga4gh/wes
apiVersion:
default: v1
tags:
- name: Service Info
description: Get information about the workflow execution service
- name: Workflow Runs
description: Submit and monitor workflows in a WES environment
- name: Introduction
description: |
This document describes the WES API and provides details on the specific endpoints, request formats, and response. It is intended to provide key information for developers of WES-compatible services as well as clients that will call these WES services.
Use cases include:
+ "Bring your code to the data": a researcher who has built their own custom analysis can submit it to run on a dataset owned by an external organization, instead of having to make a copy of the data
+ Best-practices pipelines: a researcher who maintains their own controlled data environment can find useful workflows in a shared directory (e.g. Dockstore.org), and run them over their data
## Standards
The WES API specification is written in OpenAPI and embodies a RESTful service philosophy. It uses JSON in requests and responses and standard HTTP/HTTPS for information transport.
- name: Authorization & Authentication
description: >
Users must supply credentials that establish their identity and authorization in order to use a WES endpoint. We recommend that WES implementations use an OAuth2 [**bearer token**](https://oauth.net/2/bearer-tokens/), although they can choose other mechanisms if appropriate. WES callers can use the `auth_instructions_url` from the [**`service-info` endpoint**](https://ga4gh.github.io/workflow-execution-service-schemas/#/WorkflowExecutionService/GetServiceInfo) to learn how to obtain and use a bearer token for a particular implementation.
The WES implementation is responsible for checking that a user is authorized to submit workflow run requests. The particular authorization policy is up to the WES implementer.
Systems like WES need to also address the ability to pass credentials with jobs for input and output access. In the current version of WES, the passing of credentials to authenticate and authorize access to inputs and outputs, as well as mandates about necessary file transfer protocols to support, are out of scope. However, parallel work on the Data Object Service is addressing ways to pass around access credentials with data object references, opening up the possibility that a future version of WES will provide concrete mechanisms for workflow runs to access data using credentials different than those used for WES. This is a work in progress and support of DOS in WES will be added in a future release of WES.
- name: serviceinfo_model
x-displayName: ServiceInfo
description: |
<SchemaDefinition schemaRef="#/components/schemas/ServiceInfo" />
- name: runlistresponse_model
x-displayName: RunListResponse
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunListResponse" />
- name: runid_model
x-displayName: RunId
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunId" />
- name: state_model
x-displayName: State
description: |
<SchemaDefinition schemaRef="#/components/schemas/State" />
- name: runstatus_model
x-displayName: RunStatus
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunStatus" />
- name: runsummary_model
x-displayName: RunSummary
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunSummary" />
- name: runrequest_model
x-displayName: RunRequest
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunRequest" />
- name: runlog_model
x-displayName: RunLog
description: |
<SchemaDefinition schemaRef="#/components/schemas/RunLog" />
- name: log_model
x-displayName: Log
description: |
<SchemaDefinition schemaRef="#/components/schemas/Log" />
- name: tasklog_model
x-displayName: TaskLog
description: |
<SchemaDefinition schemaRef="#/components/schemas/TaskLog" />
- name: tasklistresponse_model
x-displayName: TaskListResponse
description: |
<SchemaDefinition schemaRef="#/components/schemas/TaskListResponse" />
- name: defaultworkflowengineparameter_model
x-displayName: DefaultWorkflowEngineParameter
description: |
<SchemaDefinition schemaRef="#/components/schemas/DefaultWorkflowEngineParameter" />
- name: workflowtypeversion_model
x-displayName: WorkflowTypeVersion
description: |
<SchemaDefinition schemaRef="#/components/schemas/WorkflowTypeVersion" />
- name: workflowengineversion_model
x-displayName: WorkflowEngineVersion
description: |
<SchemaDefinition schemaRef="#/components/schemas/WorkflowEngineVersion" />
x-tagGroups:
- name: Overview
tags:
- Introduction
- Authorization & Authentication
- name: Operations
tags:
- Service Info
- Workflow Runs
- name: Models
tags:
- serviceinfo_model
- runlistresponse_model
- runid_model
- state_model
- runstatus_model
- runsummary_model
- runrequest_model
- runlog_model
- log_model
- task_model
- tasklog_model
- tasklistresponse_model
- defaultworkflowengineparameter_model
- workflowtypeversion_model
- workflowengineversion_model
paths:
/service-info:
get:
tags:
- Service Info
summary: GetServiceInfo
description: May include information related (but not limited to) the workflow descriptor formats, versions supported, the WES API versions supported, and information about general service availability.
operationId: GetServiceInfo
parameters: [ ]
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceInfo'
400:
description: The request is malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
/runs:
get:
tags:
- Workflow Runs
summary: ListRuns
description: This list should be provided in a stable ordering. (The actual ordering is implementation dependent.) When paging through the list, the client should not make assumptions about live updates, but should assume the contents of the list reflect the workflow list at the moment that the first page is requested. To monitor a specific workflow run, use GetRunStatus or GetRunLog.
operationId: ListRuns
parameters:
- name: page_size
in: query
description: OPTIONAL The preferred number of workflow runs to return in a page. If not provided, the implementation should use a default page size. The implementation must not return more items than `page_size`, but it may return fewer. Clients should not assume that if fewer than `page_size` items are returned that all items have been returned. The availability of additional pages is indicated by the value of `next_page_token` in the response.
style: form
explode: true
schema:
type: integer
format: int64
- name: page_token
in: query
description: OPTIONAL Token to use to indicate where to start getting results. If unspecified, return the first page of results.
style: form
explode: true
schema:
type: string
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/RunListResponse'
400:
description: The request is malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
post:
tags:
- Workflow Runs
summary: RunWorkflow
description: >-
This endpoint creates a new workflow run and returns a `RunId` to monitor its progress.
The `workflow_attachment` array may be used to upload files that are required to execute the workflow, including the primary workflow, tools imported by the workflow, other files referenced by the workflow, or files which are part of the input. The implementation should stage these files to a temporary directory and execute the workflow from there. These parts must have a Content-Disposition header with a "filename" provided for each part. Filenames may include subdirectories, but must not include references to parent directories with '..' -- implementations should guard against maliciously constructed filenames.
The `workflow_url` is either an absolute URL to a workflow file that is accessible by the WES endpoint, or a relative URL corresponding to one of the files attached using `workflow_attachment`.
The `workflow_params` JSON object specifies input parameters, such as input files. The exact format of the JSON object depends on the conventions of the workflow language being used. Input files should either be absolute URLs, or relative URLs corresponding to files uploaded using `workflow_attachment`. The WES endpoint must understand and be able to access URLs supplied in the input. This is implementation specific.
The `workflow_type` is the type of workflow language and must be "CWL" or "WDL" currently (or another alternative supported by this WES instance).
The `workflow_type_version` is the version of the workflow language submitted and must be one supported by this WES instance.
The `workflow_engine` is the engine that supports the workflow_type and must be supported by this WES instance.
The `workflow_engine_version` is the version of workflow engine and must be supported by this WES instance.
See the `RunRequest` documentation for details about other fields.
operationId: RunWorkflow
parameters: [ ]
requestBody:
content:
multipart/form-data:
encoding: { }
schema:
type: object
properties:
workflow_params:
type: string
workflow_type:
type: string
workflow_type_version:
type: string
tags:
type: string
workflow_engine:
type: string
workflow_engine_version:
type: string
workflow_engine_parameters:
type: string
workflow_url:
type: string
workflow_attachment:
type: array
items:
type: string
format: binary
description: ''
required: false
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/RunId'
400:
description: The request is malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
'/runs/{run_id}':
get:
tags:
- Workflow Runs
summary: GetRunLog
description: This endpoint provides detailed information about a given workflow run. The returned result has information about the outputs produced by this workflow (if available), a log object which allows the stderr and stdout to be retrieved, a log array so stderr/stdout for individual tasks can be retrieved, and the overall state of the workflow run (e.g. RUNNING, see the State section).
operationId: GetRunLog
parameters:
- name: run_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/RunLog'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: The requested workflow run not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
'/runs/{run_id}/status':
get:
tags:
- Workflow Runs
summary: GetRunStatus
description: This provides an abbreviated (and likely fast depending on implementation) status of the running workflow, returning a simple result with the overall state of the workflow run (e.g. RUNNING, see the State section).
operationId: GetRunStatus
parameters:
- name: run_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/RunStatus'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: The requested workflow run wasn't found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
'/runs/{run_id}/tasks':
get:
tags:
- Workflow Runs
summary: ListTasks
description: >-
This endpoint provides a paginated list of tasks that were executed as part of a given
workflow run. Task ordering should be the same as what would be returned in a
`RunLog` response body.
operationId: ListTasks
parameters:
- name: run_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: page_size
in: query
description: >-
OPTIONAL
The preferred number of task logs to return in a page.
If not provided, the implementation should use a default page size.
The implementation must not return more items
than `page_size`, but it may return fewer. Clients should
not assume that if fewer than `page_size` items are
returned that all items have been returned. The
availability of additional pages is indicated by the value
of `next_page_token` in the response.
style: form
explode: true
schema:
type: integer
format: int64
- name: page_token
in: query
description: >-
OPTIONAL
Token to use to indicate where to start getting results. If unspecified, return the first
page of results.
style: form
explode: true
schema:
type: string
responses:
200:
description: ''
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TaskListResponse'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: The requested workflow run wasn't found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
'/runs/{run_id}/tasks/{task_id}':
get:
tags:
- Workflow Runs
summary: GetTask
description: >-
This endpoint provides a mechanism to retrieve information on a specific task, if it exists
operationId: GetTask
parameters:
- name: run_id
in: path
description: ''
required: true
style: simple
schema:
type: string
- name: task_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/TaskLog'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: The requested task wasn't found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
'/runs/{run_id}/cancel':
post:
tags:
- Workflow Runs
summary: CancelRun
description: Cancel a running workflow.
operationId: CancelRun
parameters:
- name: run_id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
200:
description: ''
headers: { }
content:
application/json:
schema:
$ref: '#/components/schemas/RunId'
401:
description: The request is unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
403:
description: The requester is not authorized to perform this action.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
404:
description: The requested workflow run wasn't found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
500:
description: An unexpected error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
deprecated: false
components:
schemas:
ServiceInfo:
title: ServiceInfo
allOf:
- $ref: 'https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-info/v1.0.0/service-info.yaml#/components/schemas/Service'
- type: object
properties:
workflow_type_versions:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkflowTypeVersion'
supported_wes_versions:
type: array
items:
type: string
description: The version(s) of the WES schema supported by this service
supported_filesystem_protocols:
type: array
items:
type: string
description: The filesystem protocols supported by this service, currently these may include common protocols using the terms 'http', 'https', 'sftp', 's3', 'gs', 'file', or 'synapse', but others are possible and the terms beyond these core protocols are currently not fixed. This section reports those protocols (either common or not) supported by this WES service.
workflow_engine_versions:
type: object
additionalProperties:
$ref: '#/components/schemas/WorkflowEngineVersion'
default_workflow_engine_parameters:
type: array
items:
$ref: '#/components/schemas/DefaultWorkflowEngineParameter'
description: Each workflow engine can present additional parameters that can be sent to the workflow engine. This message will list the default values, and their types for each workflow engine.
system_state_counts:
type: object
additionalProperties:
type: integer
format: int64
auth_instructions_url:
type: string
description: A web page URL with human-readable instructions on how to get an authorization token for use with a specific WES endpoint.
tags:
type: object
additionalProperties:
type: string
description: A message containing useful information about the running service, including supported versions and default settings.
required:
- workflow_type_versions
- supported_wes_versions
- supported_filesystem_protocols
- workflow_engine_versions
- default_workflow_engine_parameters
- system_state_counts
- auth_instructions_url
- tags
RunId:
title: RunId
type: object
properties:
run_id:
type: string
description: workflow run ID
State:
title: State
enum:
- UNKNOWN
- QUEUED
- INITIALIZING
- RUNNING
- PAUSED
- COMPLETE
- EXECUTOR_ERROR
- SYSTEM_ERROR
- CANCELED
- CANCELING
- PREEMPTED
type: string
description: >
State can take any of the following values:
+ UNKNOWN: The state of the task is unknown. This provides a safe default for messages where this field is missing, for example, so that a missing field does not accidentally imply that the state is QUEUED.
+ QUEUED: The task is queued.
+ INITIALIZING: The task has been assigned to a worker and is currently preparing to run. For example, the worker may be turning on, downloading input files, etc.
+ RUNNING: The task is running. Input files are downloaded and the first Executor has been started.
+ PAUSED: The task is paused. An implementation may have the ability to pause a task, but this is not required.
+ COMPLETE: The task has completed running. Executors have exited without error
and output files have been successfully uploaded.
+ EXECUTOR_ERROR: The task encountered an error in one of the Executor processes. Generally,
this means that an Executor exited with a non-zero exit code.
+ SYSTEM_ERROR: The task was stopped due to a system error, but not from an Executor,
for example an upload failed due to network issues, the worker's ran out of disk space, etc.
+ CANCELED: The task was canceled by the user.
+ CANCELING: The task was canceled by the user, and is in the process of stopping.
+ PREEMPTED: The task is stopped (preempted) by the system. The reasons for this would be tied to
the specific system running the job. Generally, this means that the system reclaimed the compute
capacity for reallocation.
RunStatus:
title: RunStatus
required:
- run_id
type: object
properties:
run_id:
type: string
state:
$ref: '#/components/schemas/State'
description: State information of a workflow run
RunSummary:
title: RunSummary
allOf:
- $ref: '#/components/schemas/RunStatus'
- type: object
properties:
start_time:
type: string
description: When the run started executing, in ISO 8601 format "%Y-%m-%dT%H:%M:%SZ"
end_time:
type: string
description: When the run stopped executing (completed, failed, or cancelled), in ISO 8601 format "%Y-%m-%dT%H:%M:%SZ"
tags:
type: object
description: Arbitrary key/value tags added by the client during run creation
additionalProperties:
type: string
required:
- tags
description: Small description of a workflow run
RunRequest:
title: RunRequest
type: object
required:
- workflow_type
- workflow_type_version
- workflow_url
properties:
workflow_params:
type: object
description: >-
REQUIRED
The workflow run parameterizations (JSON encoded), including input and output file locations
workflow_type:
type: string
description: >-
REQUIRED
The workflow descriptor type, must be "CWL" or "WDL" currently (or another alternative supported by this WES instance)
workflow_type_version:
type: string
description: >-
REQUIRED
The workflow descriptor type version, must be one supported by this WES instance
tags:
type: object
additionalProperties:
type: string
workflow_engine_parameters:
type: object
additionalProperties:
type: string
workflow_engine:
type: string
description: >-
The workflow engine, must be one supported by this WES instance. Required if workflow_engine_version is provided.
workflow_engine_version:
type: string
description: >-
The workflow engine version, must be one supported by this WES instance.
If workflow_engine is provided, but workflow_engine_version is not, servers can make no assumptions with regard to the engine version the WES instance uses to process the request if
that WES instance supports multiple versions of the requested engine.
workflow_url:
type: string
description: >-
REQUIRED
The workflow CWL or WDL document. When `workflow_attachments` is used to attach files, the `workflow_url` may be a relative path to one of the attachments.
description: >-
To execute a workflow, send a run request including all the details needed to begin downloading
and executing a given workflow.
If workflow_engine and workflow_engine_version are not provided, servers can use the most recent workflow_engine_version of workflow_engine that WES instance uses to process the request if
supports for the requested workflow_type.
RunLog:
title: RunLog
type: object
properties:
run_id:
type: string
description: workflow run ID
request:
$ref: '#/components/schemas/RunRequest'
state:
$ref: '#/components/schemas/State'
run_log:
$ref: '#/components/schemas/Log'
task_logs_url:
type: string
description: A reference to the complete url which may be used to obtain a paginated list of task logs for this workflow
task_logs:
type: array
deprecated: true
nullable: true
items:
anyOf:
- $ref: '#/components/schemas/Log'
- $ref: '#/components/schemas/TaskLog'
description: >-
The logs, and other key info like timing and exit code, for each step in the workflow run.
This field is deprecated and the `task_logs_url` should be used to retrieve a paginated list
of steps from the workflow run. This field will be removed in the next major version of the
specification (2.0.0)
outputs:
type: object
description: The outputs from the workflow run.
Log:
title: Log
type: object
properties:
name:
type: string
description: The task or workflow name
cmd:
type: array
items:
type: string
description: The command line that was executed
start_time:
type: string
description: When the command started executing, in ISO 8601 format "%Y-%m-%dT%H:%M:%SZ"
end_time:
type: string
description: When the command stopped executing (completed, failed, or cancelled), in ISO 8601 format "%Y-%m-%dT%H:%M:%SZ"
stdout:
type: string
description: A URL to retrieve standard output logs of the workflow run or task. This URL may change between status requests, or may not be available until the task or workflow has finished execution. Should be available using the same credentials used to access the WES endpoint.
stderr:
type: string
description: A URL to retrieve standard error logs of the workflow run or task. This URL may change between status requests, or may not be available until the task or workflow has finished execution. Should be available using the same credentials used to access the WES endpoint.
exit_code:
type: integer
description: Exit code of the program
format: int32
system_logs:
type: array
items:
type: string
description: |-
System logs are any logs the system decides are relevant,
which are not tied directly to a workflow.
Content is implementation specific: format, size, etc.
System logs may be collected here to provide convenient access.
For example, the system may include an error message that caused
a SYSTEM_ERROR state (e.g. disk is full), etc.
description: Log and other info
DefaultWorkflowEngineParameter:
title: DefaultWorkflowEngineParameter
type: object
properties:
name:
type: string
description: The name of the parameter
type:
type: string
description: Describes the type of the parameter, e.g. float.
default_value:
type: string
description: The stringified version of the default parameter. e.g. "2.45".
description: A message that allows one to describe default parameters for a workflow engine.
WorkflowTypeVersion:
title: WorkflowTypeVersion
type: object
properties:
workflow_type_version:
type: array
items:
type: string
description: an array of one or more acceptable types for the `workflow_type`
description: Available workflow types supported by a given instance of the service.
TaskListResponse:
title: TaskListResponse
type: object
properties:
task_logs:
type: array
items:
$ref: '#/components/schemas/TaskLog'
description: The logs, and other key info like timing and exit code, for each step in the workflow run.
next_page_token:
type: string
description: >-
A token which may be supplied as `page_token` in workflow run task list request to get the next page
of results. An empty string indicates there are no more items to return.
description: The service will return a TaskListResponse when receiving a successful TaskListRequest.
TaskLog:
title: TaskLog
allOf:
- $ref: '#/components/schemas/Log'
- type: object
properties:
id:
type: string
description: A unique identifier which may be used to reference the task
system_logs:
type: array
items:
type: string
description: |-
System logs are any logs the system decides are relevant,
which are not tied directly to a task.
Content is implementation specific: format, size, etc.
System logs may be collected here to provide convenient access.
For example, the system may include the name of the host
where the task is executing, an error message that caused
a SYSTEM_ERROR state (e.g. disk is full), etc.
tes_uri:
type: string
description: An optional URL pointing to an extended task definition defined by a [TES api](https://github.com/ga4gh/task-execution-schemas)
required:
- id
- name
description: Runtime information for a given task
WorkflowEngineVersion:
title: WorkflowEngineVersion
type: object
properties:
workflow_engine_version:
type: array
items:
type: string
description: An array of one or more acceptable engines versions for the `workflow_engine`
description: Available workflow engine versions supported by a given instance of the service.
RunListResponse:
title: RunListResponse
type: object
properties:
runs:
type: array
items:
anyOf:
- $ref: '#/components/schemas/RunStatus'
- $ref: '#/components/schemas/RunSummary'
description: A list of workflow runs that the service has executed or is executing. The list is filtered to only include runs that the caller has permission to see.
next_page_token:
type: string
description: A token which may be supplied as `page_token` in workflow run list request to get the next page of results. An empty string indicates there are no more items to return.
description: >
The service will return a RunListResponse when receiving a successful RunListRequest.
DEPRECIATION WARNING: The use of `RunStatus` as the schema for `runs` array items will
not be permitted from the next major version of the specification (2.0.0) onwards. We
encourage implementers to use `RunSummary` instead.
ErrorResponse:
title: ErrorResponse
type: object
properties:
msg:
type: string
description: A detailed error message.
status_code:
type: integer
description: The integer representing the HTTP status code (e.g. 200, 404).
format: int32
description: An object that can optionally include information about the error.