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

Documentation wrongly states all downloads are JSON - section should mention it discusses "details" endpoint #926

Open
corneliusroemer opened this issue Aug 31, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@corneliusroemer
Copy link
Contributor

If I'm not misunderstanding something, this statement is incorrect with regards to (at least) sequences which by default come as FASTA

Brave Browser 2024-08-31 21 21 06

In fact, JSON isn't even accepted for sequences it seems. So this section should say that it applies to the "details" endpoint and not to sequences

@corneliusroemer corneliusroemer added the documentation Improvements or additions to documentation label Aug 31, 2024
@chaoran-chen
Copy link
Member

Thanks for pointing this out! It applies to all endpoints except the sequence endpoints (i.e., JSON is also the default for aggregated and the mutation endpoints).

@corneliusroemer
Copy link
Contributor Author

corneliusroemer commented Aug 31, 2024

Offering JSON and TSV sequence outputs would be useful actually - as one doesn't need to parse FASTA, one can use standard tools like jq/tsv-utils directly! Maybe I should make a separate issue :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants