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

docs: readd system state count description #222

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: readd system state count description #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions openapi/workflow_execution_service.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
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

Check warning on line 20 in openapi/workflow_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Open API Lint Check

info-license - #/info 

Info object should contain `license` field.
servers:
- url: https://{defaultHost}/{basePath}/{apiVersion}
variables:
Expand Down Expand Up @@ -632,6 +632,9 @@
additionalProperties:
type: integer
format: int64
description: >-
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
description: A web page URL with human-readable instructions on how to get an authorization token for use with a specific WES endpoint.
Expand Down
Loading