Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add in support for workflow engine and version when submitting a request. Closes #181 #182

Merged
merged 16 commits into from
Mar 28, 2023
Merged

feat: add in support for workflow engine and version when submitting a request. Closes #181 #182

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d4fa86b
Add in support for workflow enginer and version when submitting a req…
vsmalladi Jul 11, 2022
c6d3212
Expand out Workflow Engine version to by array of strings.
vsmalladi Jul 12, 2022
84913d2
Update RunRequest.yaml
vsmalladi Aug 9, 2022
27cd763
Add in workflow_engine and version to the run spec.
vsmalladi Aug 9, 2022
a8190f6
Fix typo
vsmalladi Aug 9, 2022
e46a97d
Fix for consitency
vsmalladi Aug 9, 2022
6012964
Add more clarity about engine and version
vsmalladi Aug 26, 2022
809fb19
Update description
vsmalladi Aug 26, 2022
c1e81b8
Address changes requested.
vsmalladi Aug 29, 2022
0832947
Merge and update to new organization.
vsmalladi Nov 15, 2022
2979bf5
Consilidate files.
vsmalladi Nov 15, 2022
88612d5
Fix indentation.
vsmalladi Nov 15, 2022
aa1cbaa
Resolve reorganization of yaml's into 1 single yaml.
vsmalladi Jan 10, 2023
a40020a
Merge branch 'develop' into workflow_engine
vsmalladi Jan 10, 2023
2b63c4e
Remove preempted with accidental merge.
vsmalladi Jan 10, 2023
8b0993f
Add required parameter for:
vsmalladi Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion openapi/components/schemas/RunRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ properties:
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, clients 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.
vsmalladi marked this conversation as resolved.
Show resolved Hide resolved
workflow_url:
type: string
description: >-
Expand All @@ -36,4 +46,4 @@ properties:
description: >-
To execute a workflow, send a run request including all the details needed to begin downloading

and executing a given workflow.
and executing a given workflow.
4 changes: 2 additions & 2 deletions openapi/components/schemas/ServiceInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ allOf:
workflow_engine_versions:
type: object
additionalProperties:
type: string
$ref: './WorkflowEngineVersion.yaml'
default_workflow_engine_parameters:
type: array
items:
Expand All @@ -47,4 +47,4 @@ allOf:
- default_workflow_engine_parameters
- system_state_counts
- auth_instructions_url
- tags
- tags
9 changes: 9 additions & 0 deletions openapi/components/schemas/WorkflowEngineVersion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
title: WorkflowEngineVersion
type: object
properties:
workflow_engine_version:
type: array
items:
type: string
description: An array of one or more acceptable engines for the `workflow_engine`
vsmalladi marked this conversation as resolved.
Show resolved Hide resolved
description: Available workflow engines supported by a given instance of the service.
8 changes: 8 additions & 0 deletions openapi/paths/runs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@
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
Expand All @@ -88,6 +92,10 @@
type: string
tags:
type: string
workflow_engine:
type: string
workflow_engine_version:
type: string
workflow_engine_parameters:
type: string
workflow_url:
Expand Down