Skip to content

Commit

Permalink
Merge pull request #19 from dockstore/feature/more_paths
Browse files Browse the repository at this point in the history
TRS Extension for locating primary descriptor in zip
  • Loading branch information
denis-yuen authored Nov 6, 2024
2 parents ec161fd + b68be11 commit 215abf8
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: 14.x
node-version: 18.x
- run: npm i -g markdown-link-check
- run: markdown-link-check ./README.md
buildPage:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ What is the Tool Registry API Schema?

This is the home of the schema for the GA4GH Tool Registry API. The GA4GH Tool Registry API is a standard for listing and describing available tools (both stand-alone, Docker-based tools as well as workflows in CWL, WDL, Nextflow, Galaxy or Snakemake) in a given registry. This defines a minimal, common API describing tools that we propose for support by multiple tool/workflow registries like [Dockstore](https://www.dockstore.org/), [BioContainers](https://biocontainers.pro), and [Agora](https://github.com/broadinstitute/agora) for the purposes of exchange, indexing, and searching.

This repo uses the [HubFlow](https://datasift.github.io/gitflow/) scheme which is closely based on [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/). In practice, this means that the master branch contains the last production release of the schema whereas the develop branch contains the latest development changes which will end up in the next production release.
This repo uses the [HubFlow](https://github.com/dockstore/hubflow) scheme which is closely based on [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/). In practice, this means that the master branch contains the last production release of the schema whereas the develop branch contains the latest development changes which will end up in the next production release.
As of July 2019, this means that the 1.0.0 version is described on master whereas the develop branch contains the 2.0.0-beta.3 version which will evolve into the 2.0.0 production release.

Our current proposal is to start with a read-only API due to potentially different views and approaches to registration/security.
Expand Down
11 changes: 11 additions & 0 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,10 @@ components:
type: string
description: Relative path of the file. A descriptor's path can be used with
the GA4GH .../{type}/descriptor/{relative_path} endpoint.
dockstore_absolute_path:
type: string
description: Absolute path of the file. A descriptor's path can be used with
zip from toolsIdVersionsVersionIdTypeFilesGet when format=zip is specified
file_type:
type: string
enum:
Expand Down Expand Up @@ -814,6 +818,13 @@ components:
url: https://raw.githubusercontent.com/ICGC-TCGA-PanCancer/pcawg_delly_workflow/ea2a5db69bd20a42976838790bc29294df3af02b/delly_docker/Delly.cwl
containerfile:
url: https://raw.githubusercontent.com/ICGC-TCGA-PanCancer/pcawg_delly_workflow/c83478829802b4d36374870843821abe1b625a71/delly_docker/Dockerfile
dockstore_self_url:
type: string
description: Self URL to this file in the toolsIdVersionsVersionIdTypeDescriptorRelativePathGet endpoint
dockstore_absolute_path:
type: string
description: Absolute path of the file. A descriptor's path can be used with
zip from toolsIdVersionsVersionIdTypeFilesGet when format=zip is specified
Error:
type: object
required:
Expand Down

0 comments on commit 215abf8

Please sign in to comment.