Skip to content

Commit

Permalink
Fix Range header description (samtools#339)
Browse files Browse the repository at this point in the history
While it was a Google Docs document, the specification was corrected
to reflect that HTTP Range byte ranges are zero-based fully-inclusive.
Update the OpenAPI description correspondingly.

Also fix typos.
  • Loading branch information
jmarshall authored and andrewyatz committed Sep 19, 2018
1 parent eb9d612 commit 98de888
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions pub/refget-openapi.yaml
Expand Up @@ -14,9 +14,9 @@ info:
url: https://www.ga4gh.org/
tags:
- name: Metadata
description: Services linked to retriving metadata from an idetifier
description: Services linked to retrieving metadata from an identifier
- name: Sequence
description: Services linked to fetching sequence from an idetifier
description: Services linked to fetching sequence from an identifier
- name: Services
description: Housekeeping services
paths:
Expand Down Expand Up @@ -81,10 +81,9 @@ paths:
name: Range
required: false
description: >-
Specify a substring as a range not using query parameters. Note
start is in Ensembl-style start coordinates i.e. the first base of a
sequence is 1 not 0 as in the start parameter. Example is 'bytes:
1-10'
Specify a substring as a single HTTP Range.
One byte range is permitted, and is 0-based inclusive.
For example, 'Range: bytes=0-9' corresponds to '?start=0&end=10'.
schema:
type: string
responses:
Expand Down

0 comments on commit 98de888

Please sign in to comment.