Skip to content

Add VCFTEXT format keyword and clarify whether VCF responses are compressed#856

Open
jmarshall wants to merge 1 commit into
samtools:masterfrom
jmarshall:vcftext
Open

Add VCFTEXT format keyword and clarify whether VCF responses are compressed#856
jmarshall wants to merge 1 commit into
samtools:masterfrom
jmarshall:vcftext

Conversation

@jmarshall
Copy link
Copy Markdown
Member

Clarifies or adjusts VCF to mean compressed, and adds VCFTEXT for uncompressed plain text — as discussed in #837.

Comment thread htsget.md

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

## 1.3.1 (May 2026)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that there are several other places in the document where the current version number needs to be bumped.

Comment thread htsget.md

VCFTEXT indicates a request for uncompressed VCF in plaintext.
When VCF is specified or by default, the server SHOULD return gzip-compressed (or BGZF-compressed) VCF data.
At present, the server MAY instead return uncompressed plaintext VCF in these cases, but this is deprecated.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add something about We will change that to MUST in 1.5 in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant