Published September 14, 2023 | Version 1.1.0
Software Open

ga4gh/workflow-execution-service-schemas: 1.1.0

Creators

  • 1. Broad Institute & Nimbus Informatics, LLC
  • 2. @Sage-Bionetworks
  • 3. Verily
  • 4. @DNAstack
  • 5. Information Commissioner's Office
  • 6. @CuriiHQ @arvados
  • 7. EMBL-EBI
  • 8. Biozentrum, University of Basel & SIB Swiss Institute of Bioinformatics / ELIXIR Switzerland
  • 9. @OICR_news
  • 10. Adela
  • 11. @common-workflow-language
  • 12. Broad Institute

Description

Motivation

This release focuses on two main themes: Observability and Scalability.

Observability: As more people have adopted WES it has become clear that the current API does not provide enough information for end users. The RunStatus and Log models have limited required keys and making actionable decisions on the information that is available is difficult without performing additional requests.

Scalability: As more implementors are looking to "productize" WES, the topic of scalability has continuously come up. Specific features of WES (such as embedded task logs) make implementing WES API a challenge, and can cause the service to break (Ie too many task cause a service to consume too much memory).

What's Changed
  • feat: added run state PREEMPTED by @vsmalladi in #188
  • feat: add in support for workflow engine and version when submitting a request by @vsmalladi in #182
  • feat: add alternative schema for array items in RunListResponse by @uniqueg in #207
    • DEPRECATION NOTICE: the RunListResponse model will only return RunSummary starting in 2.0.0
  • feat: created a new endpoint to paginate run tasks by @patmagee in #177
    • DEPRECATION NOTICE: the task_logs property in the RunLog model has been deprecated in favour of the task list endpoint, and will be removed in 2.0.0
  • feat: make Tasks Addressable by ID and extend available information in the task log by @patmagee in #205
Additional Improvements
  • Removed travis CI integration and added GitHub actions for publishing docs and linting openapi.yaml
  • Removed example python client code in b5f782e
  • Removed duplicated swagger specification in favour of consolidated OpenAPI3 specification

Files

ga4gh/workflow-execution-service-schemas-1.1.0.zip

Files (20.0 kB)

Additional details

Related works

Is supplement to
https://github.com/ga4gh/workflow-execution-service-schemas/tree/1.1.0 (URL)