common-workflow-language / common-workflow-language/workflow-service

Workflow API usage examples

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
39
Forks
21
PR merge metrics
No merged PRs in 30d

Description

This project would benefit having some examples in the README showing how this API is expected to be used.

This is also particularly relevant because the workflow execution request object contains many fields with a generic name. It's not easily understandable how to specify the workflow to be executed, the required input/output objects and any other required data.

There's a small example in the [reference implementation](https://github.com/common-workflow-language/workflow-service/tree/ga4gh-wes) project but it doesn't seem to be aligned with the current schema definition.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the README and current schema definition, then compare them with the small example in the linked reference implementation. Add aligned usage examples showing how to specify the workflow, required input and output objects, and other required data; done means the README examples match the current schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.