You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository is the home for the schema for the GA4GH Tool Registry API. The goal of the API is to provide a standardized way to describe the availability of tools and workflows. In this way, we can have multiple repositories that share Docker-based tools and WDL/CWL/Nextflow-based workflows and have a consistent way to interact, search, and retrieve information from these various registries. The end goal is to make it much easier to share scientific tools and workflows, enhancing our ability to make research reproducible, sharable, and transparent.
9
+
This repository is the home for the schema for the GA4GH Tool Registry API. The goal of the API is to provide a standardized way to describe the availability of tools and workflows. In this way, we can have multiple repositories that share Docker-based tools and WDL/CWL/Nextflow/Galaxy/Snakemake-based workflows and have a consistent way to interact, search, and retrieve information from these various registries. The end goal is to make it much easier to share scientific tools and workflows, enhancing our ability to make research reproducible, sharable, and transparent.
10
10
11
-
**See the human-readable [Reference Documentation](https://ga4gh.github.io/tool-registry-service-schemas). You can also explore the specification in the [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh/tool-registry-schemas/develop/openapi/ga4gh-tool-discovery.yaml).***Manually load the JSON if working from a non-develop branch version.*
11
+
**See the human-readable [Reference Documentation](https://ga4gh.github.io/tool-registry-service-schemas). You can also explore the specification in the [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh/tool-registry-schemas/develop/openapi/openapi.yaml).***Manually load the JSON if working from a non-develop branch version.* Preview documentation from the [gh-openapi-docs](https://github.com/ga4gh/gh-openapi-docs) for the development branch [here](https://ga4gh.github.io/tool-registry-service-schemas/preview/develop/docs/index.html)
12
12
13
13
The [Global Alliance for Genomics and Health](http://genomicsandhealth.org/) (GA4GH) is an international
14
14
coalition, formed to enable the sharing of genomic and clinical data.
@@ -26,7 +26,7 @@ The Containers & Workflows working group is an informal, multi-vendor working gr
26
26
What is the Tool Registry API Schema?
27
27
-------------------------------------
28
28
29
-
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, WDLor Nextflow) 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.
29
+
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.
30
30
31
31
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.
32
32
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.
@@ -36,7 +36,8 @@ Our current proposal is to start with a read-only API due to potentially differe
36
36
Key features of the current API proposal:
37
37
38
38
* read-only API
39
-
* May serve up CWL, WDL or Nextflow to describe a tool or represent a workflow depending on the tool/workflow submitter
39
+
* May serve up CWL, WDL, Nextflow, Galaxy or Snakemake to describe a tool or represent a workflow
40
+
depending on the tool/workflow submitter
40
41
* ID: globally unique across systems and also identifies the system that it came from (ex: [email protected] )
41
42
42
43
@@ -50,7 +51,7 @@ Outstanding questions:
50
51
How to view
51
52
------------
52
53
53
-
See the swagger editor to view our [schema in progress](https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh/tool-registry-schemas/develop/openapi/ga4gh-tool-discovery.yaml).
54
+
See the swagger editor to view our [schema in progress](https://editor.swagger.io/?url=https://raw.githubusercontent.com/ga4gh/tool-registry-schemas/develop/openapi/openapi.yaml).
To make changes to the TRS, join the GA4GH organization or ask to join this repository as a collaborator. Then in your branch, modify:
4
-
- The swagger yaml file (`ga4gh-tool-discovery.yaml`) with a Swagger 2 definition of the changes.
5
-
- This swagger yaml file will be used in the validation server.
6
-
- An OpenAPI yaml file (`openapi.yaml`) with an OpenAPI 3 definition of the changes will be auto-generated by swagger2openapi and checked in by an automated TravisCI build
4
+
- The openapi.yaml file with an OpenAPI 3 definition of the changes.
5
+
- This openapi yaml file will be used in the TRS validation server.
7
6
7
+
The v1 directory should not be modified. It provides backward compatibility support for TRS servers/clients.
0 commit comments