Skip to content

Commit

Permalink
Merge pull request #32 from jaeddy/workflow-job
Browse files Browse the repository at this point in the history 
Rename misleading "workflows" endpoints as "workflow-runs"
  • Loading branch information
@briandoconnor
briandoconnor committed Jul 2, 2018
2 parents 3fb5e6e + 41fb42a commit 67729e4
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 56 deletions.
104 changes: 52 additions & 52 deletions openapi/workflow_execution_service.swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ basePath: /ga4gh/wes/v1
swagger: '2.0'
info:
title: Workflow Execution Service
version: 0.2.1
version: 0.2.2
schemes:
- http
- https
Expand Down Expand Up @@ -41,23 +41,23 @@ paths:
$ref: '#/definitions/ErrorResponse'
tags:
- WorkflowExecutionService
/workflows:
/workflow-runs:
get:
summary: |-
List submitted workflows. This should be provided in a stable
List the workflow runs. This should be provided in a stable
ordering, however the ordering of this list 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 GetWorkflowStatus or GetWorkflowLog.
workflow run, use GetWorkflowRunStatus or GetWorkflowRunLog.
x-swagger-router-controller: ga4gh.wes.server
operationId: ListWorkflows
operationId: ListWorkflowRuns
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WorkflowListResponse'
$ref: '#/definitions/WorkflowRunListResponse'
'400':
description: The request is malformed.
schema:
Expand Down Expand Up @@ -101,7 +101,7 @@ paths:
- name: tag_search
description: |-
OPTIONAL
For each key, if the key's value is empty string then match workflows that are tagged with
For each key, if the key's value is empty string then match runs that are tagged with
this key regardless of value.
in: query
required: false
Expand All @@ -110,7 +110,7 @@ paths:
- WorkflowExecutionService
post:
summary: |-
Run a workflow, this endpoint will allow you to create a new workflow request and
Submit a workflow run, this endpoint will allow you to create a new run request and
retrieve its tracking ID to monitor its progress. An important assumption in this
endpoint is that the workflow_params JSON will include parameterizations along with
input and output files. The latter two may be on S3, Google object storage, local filesystems,
Expand Down Expand Up @@ -147,25 +147,25 @@ paths:
in: body
required: true
schema:
$ref: '#/definitions/WorkflowRequest'
$ref: '#/definitions/WorkflowRunRequest'
tags:
- WorkflowExecutionService
'/workflows/{workflow_id}':
/workflow-runs/{run_id}:
get:
summary: Get detailed info about a running workflow.
summary: Get detailed info about a workflow run.
x-swagger-router-controller: ga4gh.wes.server
operationId: GetWorkflowLog
operationId: GetWorkflowRunLog
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WorkflowLog'
$ref: '#/definitions/WorkflowRunLog'
'401':
description: The request is unauthorized.
schema:
$ref: '#/definitions/ErrorResponse'
'404':
description: The requested Workflow found.
description: The requested workflow run not found.
schema:
$ref: '#/definitions/ErrorResponse'
'403':
Expand All @@ -177,7 +177,7 @@ paths:
schema:
$ref: '#/definitions/ErrorResponse'
parameters:
- name: workflow_id
- name: run_id
in: path
required: true
type: string
Expand All @@ -186,7 +186,7 @@ paths:
delete:
summary: Cancel a running workflow.
x-swagger-router-controller: ga4gh.wes.server
operationId: CancelJob
operationId: CancelWorkflowRun
responses:
'200':
description: ''
Expand All @@ -197,7 +197,7 @@ paths:
schema:
$ref: '#/definitions/ErrorResponse'
'404':
description: The requested Workflow wasn't found.
description: The requested workflow run wasn't found.
schema:
$ref: '#/definitions/ErrorResponse'
'403':
Expand All @@ -209,28 +209,28 @@ paths:
schema:
$ref: '#/definitions/ErrorResponse'
parameters:
- name: workflow_id
- name: run_id
in: path
required: true
type: string
tags:
- WorkflowExecutionService
'/workflows/{workflow_id}/status':
/workflow-runs/{run_id}/status:
get:
summary: Get quick status info about a running workflow.
summary: Get quick status info about a workflow run.
x-swagger-router-controller: ga4gh.wes.server
operationId: GetWorkflowStatus
operationId: GetWorkflowRunStatus
responses:
'200':
description: ''
schema:
$ref: '#/definitions/WorkflowStatus'
$ref: '#/definitions/WorkflowRunStatus'
'401':
description: The request is unauthorized.
schema:
$ref: '#/definitions/ErrorResponse'
'404':
description: The requested Workflow wasn't found.
description: The requested workflow run wasn't found.
schema:
$ref: '#/definitions/ErrorResponse'
'403':
Expand All @@ -242,7 +242,7 @@ paths:
schema:
$ref: '#/definitions/ErrorResponse'
parameters:
- name: workflow_id
- name: run_id
in: path
required: true
type: string
Expand Down Expand Up @@ -271,7 +271,7 @@ definitions:
type: array
items:
type: string
title: The command line that was run
title: The command line that was executed
start_time:
type: string
title: When the command started executing, in ISO 8601 format "%Y-%m-%dT%H:%M:%SZ"
Expand Down Expand Up @@ -342,7 +342,7 @@ definitions:
type: integer
format: int64
description: |-
The system statistics, key is the statistic, value is the count of workflows in that state.
The system statistics, key is the statistic, value is the count of runs in that state.
See the State enum for the possible keys.
auth_instructions_url:
type: string
Expand Down Expand Up @@ -401,55 +401,55 @@ definitions:
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.
title: Enumeration of states for a given workflow request
WorkflowDescription:
title: Enumeration of states for a given run request
WorkflowRunDescription:
type: object
properties:
workflow_id:
run_id:
type: string
title: REQUIRED
state:
$ref: '#/definitions/State'
title: REQUIRED
title: 'Small description of workflows, returned by server during listing'
WorkflowListResponse:
title: 'Small description of workflow runs, returned by server during listing'
WorkflowRunListResponse:
type: object
properties:
workflows:
workflow_runs:
type: array
items:
$ref: '#/definitions/WorkflowDescription'
description: A list of workflows that the service has executed or is executing.
$ref: '#/definitions/WorkflowRunDescription'
description: A list of workflow runs that the service has executed or is executing.
next_page_token:
type: string
description: |-
A token which may be supplied as "page_token" in workflow list request to get the next page
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 workflow_list_response when receiving a successful workflow_list_request.
description: The service will return a workflow_run_list_response when receiving a successful workflow_run_list_request.
WorkflowLog:
type: object
properties:
workflow_id:
run_id:
type: string
title: workflow ID
title: workflow run ID
request:
$ref: '#/definitions/WorkflowRequest'
$ref: '#/definitions/WorkflowRunRequest'
description: The original request message used to initiate this execution.
state:
$ref: '#/definitions/State'
title: state
workflow_log:
run_log:
$ref: '#/definitions/Log'
title: 'the logs, and other key info like timing and exit code, for the overall run of this workflow'
task_logs:
type: array
items:
$ref: '#/definitions/Log'
title: 'the logs, and other key info like timing and exit code, for each step in the workflow'
title: 'the logs, and other key info like timing and exit code, for each step in the workflow run'
outputs:
$ref: '#/definitions/WesObject'
title: the outputs
WorkflowRequest:
WorkflowRunRequest:
type: object
properties:
workflow_descriptor:
Expand All @@ -465,7 +465,7 @@ definitions:
$ref: '#/definitions/WesObject'
description: |-
REQUIRED
The workflow parameterization document (typically a JSON file), includes all parameterizations for the workflow
The workflow run parameterization document (typically a JSON file), includes all parameterizations for the run
including input and output file locations.
workflow_type:
type: string
Expand All @@ -483,7 +483,7 @@ definitions:
type: string
title: |-
OPTIONAL
A key-value map of arbitrary metadata outside the scope of the workflow_params but useful to track with this workflow request
A key-value map of arbitrary metadata outside the scope of the run_params but useful to track with this run request
workflow_engine_parameters:
type: object
additionalProperties:
Expand All @@ -500,20 +500,20 @@ definitions:
workflow descriptor files is offered, the `workflow_url` should be set to the relative path
of the main workflow descriptor.
description: |-
To execute a workflow, send a workflow request including all the details needed to begin downloading
To execute a workflow, send a run request including all the details needed to begin downloading
and executing a given workflow.
WorkflowRunId:
type: object
properties:
workflow_id:
run_id:
type: string
title: workflow ID
WorkflowStatus:
title: workflow run ID
WorkflowRunStatus:
type: object
properties:
workflow_id:
run_id:
type: string
title: workflow ID
title: workflow run ID
state:
$ref: '#/definitions/State'
title: state
Expand All @@ -528,7 +528,7 @@ definitions:
an array of one or more acceptable types for the Workflow Type. For
example, to send a base64 encoded WDL gzip, one could would offer
"base64_wdl1.0_gzip". By setting this value, and the path of the main WDL
to be executed in the workflow_url to "main.wdl" in the WorkflowRequest.
to be executed in the workflow_url to "main.wdl" in the WorkflowRunRequest.
description: Available workflow types supported by a given instance of the service.
WesObject:
type: object
Expand All @@ -545,4 +545,4 @@ definitions:
description: A detailed error message.
status_code:
type: integer
description: The integer representing the HTTP status code (e.g. 200, 404).
description: The integer representing the HTTP status code (e.g. 200, 404).
8 changes: 4 additions & 4 deletions python/ga4gh/wes/controllers.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
DEFAULT_PAGE_SIZE = 100


def GetWorkflowLog(**kwargs):
def GetWorkflowRunLog(**kwargs):
return {}


def CancelJob(**kwargs):
def CancelWorkflowRun(**kwargs):
return {}


def ListWorkflows(**kwargs):
def ListWorkflowRuns(**kwargs):
return {}


Expand All @@ -25,5 +25,5 @@ def RunWorkflow(**kwargs):
return {}


def GetWorkflowStatus(**kwargs):
def GetWorkflowRunStatus(**kwargs):
return {}

0 comments on commit 67729e4

Please sign in to comment.