General Exec Summary of WES

[rishidev]

The GA4GH Product Approval Process stipulates the specification should be in a format such as Markdown, and lays out suggested sections for the document. The specification will be prepared in Google Docs and then added as a MD file here.

[rishidev]

Introduction to the API that can be used to embellish into the Swagger. The README.md file also needs updating, this could match this.

[briandoconnor]

See https://docs.google.com/document/d/1EOU-Ku3sSB_Pbvdw-wxWFb9koya5Ql3esHW4uMPsLy8/edit?ts=5b3a3f15

[briandoconnor]

We need like a paragraph overview of WES that will be submitted in the approval process and also used in a MD doc that includes the autogenerated summary of the API endpoints.

See #75

[briandoconnor]

The Workflow Execution Service API describes how a user can submit workflow requests to workflow execution systems, and monitor their execution, in a standard way. Having this API supported by multiple execution engines lets users run a single CWL or WDL workflow in multiple different platforms, clouds, and environments.

Key features of the current API proposal:

• ability to request a workflow run using CWL or WDL
• ability to parameterize that workflow using a JSON schema
• ability to get information about running workflows, status, errors, output file locations, etc.

This is v1, need to revise the above and flesh out more for readers that are totally new to WES.

[jaeddy]

You can add the Executive Summary text to front_matter.adoc under docs/asciidoc/. I've added some placeholder sections for this and other content, based on the GA4GH recommendations.

You can technically edit the doc directly within GitHub, view a preview, and then commit to develop — or you can stick with the normal fork and PR convention.

Assuming you won't need to do too much fancy formatting, but here's a quick guide for asciidoc syntax compared to markdown.

[dglazer]

I created #89 to add a (slightly cleaned up) version of this summary.