ga4gh / data-repository-service-schemas

A repository for the schemas used for the Data Repository Service.
Apache License 2.0
60 stars 53 forks source link
GA4GH Logo

Data Repository Service (DRS) API

develop branch status: Build Status Swagger Validator DOI

The Global Alliance for Genomics and Health (GA4GH) is an international coalition, formed to enable the sharing of genomic and clinical data.

About the GA4GH Cloud Work Stream

The GA4GH Cloud Work Stream helps the genomics and health communities take full advantage of modern cloud environments. Our initial focus is on “bringing the algorithms to the data”, by creating standards for defining, sharing, and executing portable workflows.

We work with platform development partners and industry leaders to develop standards that will facilitate interoperability.

What is DRS?

The Data Repository Service (DRS) API provides a generic interface to data repositories so data consumers, including workflow systems, can access data in a single, standardized way regardless of where it’s stored or how it’s managed. The primary functionality of DRS is to map a logical ID to a means for physically retrieving the data represented by the ID.

For more information see our HTML documentation links in the table below.

API Definition

Branch Reference Documentation Swagger Editor
develop: the stable development branch, into which feature branches are merged HTML Swagger Editor
release 1.4.0: The 1.4.0 release of DRS adds bulk operations. HTML Swagger Editor
release 1.3.0: The 1.3.0 release of DRS adds the ability to use the options request method to return the auth issuers for a specific DRS object. HTML Swagger Editor
release 1.2.0: The 1.2.0 release of DRS adds the standardized /service-info endpoint, and 2 POST endpoints that are functionally equivalent to the current GET endpoints, but they enable the submission of large passport tokens in the request body. HTML Swagger Editor
release 1.1.0: The 1.1.0 release of DRS that includes no API changes only documentation changes. This introduces a new URI convention using compact identifiers along with clear directions on how to use identifiers.org/n2t.net to resolve them. HTML Swagger Editor
release 1.0.0: The 1.0.0 release of DRS that is now an approved GA4GH standard HTML Swagger Editor
release 0.1: Simplifying DRS to core functionality HTML Swagger Editor
release 0.0.1: The initial DRS after the rename from DOS HTML Swagger Editor

To monitor development work on various branches, add 'preview/\<branch-name>' to the master URLs above (e.g., https://ga4gh.github.io/data-repository-service-schemas/preview/<branch-name>/docs).

How to Contribute Changes

See CONTRIBUTING.md.

If a security issue is identified with the specification, please send an email to security-notification@ga4gh.org detailing your concerns.

License

See the LICENSE.

More Information