data-repository-service-schemas icon indicating copy to clipboard operation
data-repository-service-schemas copied to clipboard

DRS URI example in Contents definition is wrong

Open ddietterich opened this issue 5 years ago • 1 comments

The Contents object is supposed to be a list of DRS URIs. The example of a DRS URI incorrectly includes most of the ga4gh REST API path:

      drs_uri:
        type: array
        description: >-
          A list of full DRS identifier URI paths
          that may be used to obtain the object.
          These URIs may be external to this DRS instance.
        example:
          drs://example.com/ga4gh/drs/v1/objects/{object_id}
        items:
          type: string

I will submit a PR to remove the /ga4gh/drs/v1/objects

ddietterich avatar Aug 22 '19 18:08 ddietterich

Related to this, it seems that the sentence 'Strings of the form drs:/// mean “you can fetch the content with DRS id from the DRS server at "' in section 3.2 is imprecise. However, as the next paragraph in section 3.2 states, such a DRS URI can be used "to learn how to fetch that object".

Similarly, the description of drs_uri in section 6.4 ContentsObject describes the element as "A list of full DRS identifier URI paths that may be used to obtain the object." when, in fact, they can be used to learn how to obtain the object.

I think this distinction is important and the text should be clarified so that readers do not get the impression that a DRS URI is like an Access URL.

bcli4d avatar Aug 29 '19 21:08 bcli4d