Skip to content

Commit

Permalink
Merge branch 'release/drs-0.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
briandoconnor committed Apr 28, 2019
2 parents 389b3ee + b94ba3e commit 87ca873
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 22 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ branches:
- /^\d+\.\d+(\.\d+)?(-\S*)?$/
- /^feature\/issue-\d+(-\S*)?$/
- "/^release\\/\\d+\\.\\d+(\\.\\d+)?$/"
- "/^release\\/(drs-)?\\d+\\.\\d+(\\.\\d+)?$/"

stages:
- linting
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# Data Repository Service (DRS) API

<sup>`master` branch status: </sup>[![Build Status](https://travis-ci.org/ga4gh/data-repository-service-schemas.svg?branch=master)](https://travis-ci.org/ga4gh/data-repository-service-schemas?branch=master)
<a href="https://ga4gh.github.io/data-repository-service-schemas/swagger.yaml"><img src="http://online.swagger.io/validator?url=https://ga4gh.github.io/data-repository-service-schemas/swagger.yaml" alt="Swagger Validator" height="20em" width="72em"></A>
<sup>`develop` branch status: </sup>[![Build Status](https://travis-ci.org/ga4gh/data-repository-service-schemas.svg?branch=develop)](https://travis-ci.org/ga4gh/data-repository-service-schemas?branch=develop)
<a href="https://ga4gh.github.io/data-repository-service-schemas/preview/develop/swagger.yaml"><img src="http://online.swagger.io/validator?url=https://ga4gh.github.io/data-repository-service-schemas/preview/develop/swagger.yaml" alt="Swagger Validator" height="20em" width="72em"></A>
<!--
[![Read the Docs badge](https://readthedocs.org/projects/data-repository-service/badge/)](https://data-repository-service.readthedocs.io/en/latest)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ga4gh-drs-schemas.svg)
Expand All @@ -22,7 +22,7 @@ We work with platform development partners and industry leaders to develop stand
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, standard way regardless of where it’s stored and 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 [Documentation](https://ga4gh.github.io/data-repository-service-schemas/docs/).
For more information see our HTML documentation links in the table below.

# API Definition

Expand All @@ -31,7 +31,7 @@ For more information see our [Documentation](https://ga4gh.github.io/data-reposi
| **master**: the current release | [HTML](https://ga4gh.github.io/data-repository-service-schemas/docs/) | [Swagger](https://ga4gh.github.io/data-repository-service-schemas/swagger-ui/#/DataRepositoryService/) |
| **develop**: the stable development branch, into which feature branches are merged | [HTML](https://ga4gh.github.io/data-repository-service-schemas/preview/develop/docs/) | [Swagger](https://ga4gh.github.io/data-repository-service-schemas/preview/develop/swagger-ui/#/DataRepositoryService/) |
| **release 0.0.1**: the initial DRS after the rename from DOS | [HTML](https://ga4gh.github.io/data-repository-service-schemas/preview/release/0.0.1/docs/) | [Swagger](https://ga4gh.github.io/data-repository-service-schemas/preview/release/0.0.1/swagger-ui/#/DataRepositoryService/) |
| **release 0.1**: simplifying DRS to core functionality | [HTML](https://ga4gh.github.io/data-repository-service-schemas/preview/release/0.1/docs/) | [Swagger](https://ga4gh.github.io/data-repository-service-schemas/preview/release/0.1/swagger-ui/#/DataRepositoryService/) |
| **release 0.1**: simplifying DRS to core functionality | [HTML](https://ga4gh.github.io/data-repository-service-schemas/preview/release/drs-0.1.0/docs/) | [Swagger](https://ga4gh.github.io/data-repository-service-schemas/preview/release/drs-0.1.0/swagger-ui/#/DataRepositoryService/) |

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').

Expand Down
2 changes: 1 addition & 1 deletion docs/asciidoc/back_matter.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


== Motivation
== Appendix: Motivation

[cols="40a,60a"]
|===
Expand Down
19 changes: 3 additions & 16 deletions docs/asciidoc/front_matter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The primary functionality of DRS is to map a logical ID to a means for physicall

=== DRS IDs

Each implementation of DRS v1 can choose its own id scheme, as long as it follows these guidelines:
Each implementation of DRS can choose its own id scheme, as long as it follows these guidelines:

* DRS IDs are URL-safe text strings made up of alphanumeric characters and any of [.-_/]
* One DRS ID MUST always return the same object data (or, in the case of a collection, the same set of objects). This constraint aids with reproducibility.
* DRS does NOT support semantics around multiple versions of an object. (For example, there’s no notion of “get latest version” or “list all versions” in DRS v1.) Individual implementation MAY choose an ID scheme that includes version hints.
* DRS v1 does NOT support semantics around multiple versions of an object. (For example, there’s no notion of “get latest version” or “list all versions”.) Individual implementation MAY choose an ID scheme that includes version hints.
* DRS implementations MAY have more than one ID that maps to the same object.

=== DRS Datatypes
Expand All @@ -28,20 +28,7 @@ DRS v1 is a read-only API. We expect that each implementation will define its ow

=== URI convention

For convenience, we define a recommended syntax for fully referencing DRS-accessible objects. Strings of the form drs://<server>/<path>/<[bundle|object]>/<endpoint>/<id> mean “make a DRS
GET to the HTTPS address at <server>, passing in the DRS id <id> at the end of the appropriate <path>/<[bundle|object]>/<endpoint>, to retrieve the DRS JSON response”.
The <endpoint> is optional depending on what you are doing e.g. the <endpoint> is /access when retrieving a particular access method. This is all just
a complicated way of just saying "replace drs:// with https:// and GET on the URL that results."

For example:

* drs://test.drs.org/ga4gh/drs/v1/bundles/5007fc21-6430-4fb9-82b3-520c60e26751 -> maps to a GET request to https://test.drs.org/ga4gh/drs/v1/bundles/5007fc21-6430-4fb9-82b3-520c60e26751
* drs://test.drs.org/ga4gh/drs/v1/objects/65a3e501-7448-4887-aada-b52de5c8db31 -> maps to a GET request to https://test.drs.org/ga4gh/drs/v1/objects/65a3e501-7448-4887-aada-b52de5c8db31
* drs://test.drs.org/ga4gh/drs/v1/objects/65a3e501-7448-4887-aada-b52de5c8db31/access/1 -> maps to a GET request to https://test.drs.org/ga4gh/drs/v1/objects/65a3e501-7448-4887-aada-b52de5c8db31/access/1

The service-info endpoint can be queried to retrieve information about the version of DRS supported by this server e.g. https://<server>/<path>/service-info

These URIs will be useful when passing objects to a WES server for processing since they provide a way to understand how to successfully make an HTTPS request and process the JSON response.
For convenience, including when passing content references to a WES server, we intend to define a recommended URI syntax. The syntax will probably use URI strings beginning with `drs://` -- details are being discussed in https://github.com/ga4gh/data-repository-service-schemas/issues/252[DRS#252].

=== Standards

Expand Down
2 changes: 1 addition & 1 deletion docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
include::{generated}/overview.adoc[]
include::front_matter.adoc[]
include::back_matter.adoc[]
include::{generated}/paths.adoc[]
include::{generated}/definitions.adoc[]
include::back_matter.adoc[]

0 comments on commit 87ca873

Please sign in to comment.