From 2da38c198d192e5150f983077edf89373a94681e Mon Sep 17 00:00:00 2001 From: David Glazer Date: Mon, 27 Aug 2018 17:04:14 -0700 Subject: [PATCH] add an executive summary Added text from #37 --- docs/asciidoc/front_matter.adoc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/asciidoc/front_matter.adoc b/docs/asciidoc/front_matter.adoc index ca89ee98..40dd204f 100644 --- a/docs/asciidoc/front_matter.adoc +++ b/docs/asciidoc/front_matter.adoc @@ -1,6 +1,13 @@ == Executive Summary -An executive summary summarising the major points of the document. To be added for https://github.com/ga4gh/workflow-execution-service-schemas/issues/37[issue #37]. +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 https://www.commonwl.org/[CWL] or http://www.openwdl.org/[WDL] workflow 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 == Introduction