Comments (6)
Introduction to the API that can be used to embellish into the Swagger. The README.md file also needs updating, this could match this.
from workflow-execution-service-schemas.
See https://docs.google.com/document/d/1EOU-Ku3sSB_Pbvdw-wxWFb9koya5Ql3esHW4uMPsLy8/edit?ts=5b3a3f15
from workflow-execution-service-schemas.
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
from workflow-execution-service-schemas.
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.
from workflow-execution-service-schemas.
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.
from workflow-execution-service-schemas.
I created #89 to add a (slightly cleaned up) version of this summary.
from workflow-execution-service-schemas.
Related Issues (20)
- Semantics of error states ambiguous HOT 2
- CWL: support for uploading (private) containers HOT 12
- Add Workflow engine and version to RunWorkflow parameters HOT 11
- WES API clients HOT 1
- Separate default engine parameters for different engines in the service info HOT 2
- Proposal: New WES State for Preemption HOT 1
- Optional ServiceInfo on supported workflows HOT 10
- No tag/release for version 1.0.1 HOT 24
- Versioned documentation
- Default branch & release model HOT 4
- Integrate OpenAPI validator into CI
- Field for run/task error messages (beyond stderr) HOT 8
- Workflow file authorization HOT 6
- Rerun workflows HOT 3
- Add unique identifier and additional information to tasks HOT 12
- In which field of the wes interface should the logs of the Cromwell engine and the tes server be reflected? HOT 7
- Sandbox log improvements
- Add support for external logging schemas
- Consider using externalized common logging base model for WES and TES HOT 1
- Request to Add `DELETE /runs/{run_id}` Endpoint HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from workflow-execution-service-schemas.