Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add encryptionScheme parameter to htsget #808

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions htsget.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This data retrieval API bridges from existing genomics bulk data transfers to a

* Incumbent data formats (BAM, CRAM) are preferred initially, with a future path to others.
* Multiple server implementations are supported, including those that do format transcoding on the fly, and those that return essentially unaltered filesystem data.
* Multiple encryption schemes on the files are supported, including but not limited to [Crypt4GH](https://samtools.github.io/hts-specs/crypt4gh.pdf).
* Multiple use cases are supported, including access to small subsets of genomic data (e.g. for browsing a given region) and to full genomes (e.g. for calling variants).
* Clients can provide hints of the information to be retrieved; servers can respond with more information than requested but not less.
* We use the following conventions:
Expand Down Expand Up @@ -206,6 +207,17 @@ The server SHOULD respond with an `InvalidInput` error if any other htsget query
</td></tr>
<tr markdown="block"><td>

`encryptionScheme`
_optional_
</td><td>
Request data encrypted with a particular encryption scheme.

If `encryptionScheme` is specified a 4 letter value for the encryption standard MUST be provided. When `c4gh` is specified, Crypt4GH payload for a particular object will be returned (if available).

The server SHOULD reply with a `NotFound` error if the requested (encrypted) id does not exist.
</td></tr>
<tr markdown="block"><td>

`referenceName`
_optional_
</td><td>
Expand Down Expand Up @@ -761,6 +773,11 @@ Example listing of htsget reads API and variants API registrations from a servic

This appendix lists the significant functionality introduced and changes made in each published version of the htsget protocol.

## 1.3.1 (February 2025)
{:.no_toc}

Added an `encryptionScheme` query parameter for requesting encrypted payload of any object (any underlying bioinformatics format).

## 1.3.0 (March 2021)
{:.no_toc}

Expand Down