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

Improve docs on data formats #925

Open
corneliusroemer opened this issue Aug 31, 2024 · 4 comments
Open

Improve docs on data formats #925

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

Comments

@corneliusroemer
Copy link
Contributor

corneliusroemer commented Aug 31, 2024

If I understand the docs correctly, I must send a POST to get metadata.tsv as opposed to JSON. Is that correct? Docs link: https://lapis-three.vercel.app/references/additional-request-properties/#data-format

If so, it would be nice to allow specifying the format via URL param, at least for common case of tsv, otherwise one can't request it quickly in the browser, and it's more complicated to do via curl as well.

Update, I missed the Note at the bottom - it's not very easy to find, rather than being a Note, this should be in the main text and also it should not refer to swagger (swagger is good but it's tedious, also chatgpt doesn't read swagger ;) )

Brave Browser 2024-08-31 21 17 01
@corneliusroemer corneliusroemer added the documentation Improvements or additions to documentation label Aug 31, 2024
@chaoran-chen chaoran-chen changed the title Support GETting tsv files Improve docs on data formats Aug 31, 2024
@chaoran-chen
Copy link
Member

chaoran-chen commented Aug 31, 2024

You can also use the dataFormat parameter which is mentioned here but I agree that it is not mentioned clearly enough in the main text. Thanks for pointing this out!

Example: https://lapis.pathoplexus.org/ebola-sudan/sample/details?dataFormat=tsv&downloadAsFile=true

@chaoran-chen
Copy link
Member

chaoran-chen commented Aug 31, 2024

(You can also set the accept header in a GET request. I first misread your message/didn't read the note and thought that this is what you found out.)

@fengelniederhammer
Copy link
Contributor

chatgpt doesn't read swagger

But it does read the OpenAPI spec (Swagger is also just a UI on top of that).

@corneliusroemer
Copy link
Contributor Author

By reading I meant it reads it if Bing has indexed it - I'm not very sure that swagger gets indexed well by Bing.

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

3 participants