Provide examples to query for SVs and cases in readme file

Clinical-Genomics / loqusdbapi

A simple REST api for loqusdb

2 stars 0 forks source link

Closed northwestwitch closed 3 years ago

northwestwitch commented 3 years ago

Send a query the svs endpoint
Send a query to the cases endpoint to get n_cases with SNVs and n_cases with SVs
send a query to cases endpoint to get info on a specific case

This version is a:

[ ] MAJOR - when you make incompatible API changes
[ ] MINOR - when you add functionality in a backwards compatible manner
[x] PATCH - when you make backwards compatible bug fixes or documentation/instructions

northwestwitch commented 3 years ago

Query for SVs:

Query n_cases:

Query one case:

moonso commented 3 years ago

Hi! Did you try the generated docs? Run the server and go to host:port/docs, it is super nice interface to test the REST api

northwestwitch commented 3 years ago

Hi! Did you try the generated docs? Run the server and go to host:port/docs, it is super nice interface to test the REST api

Yes, I tried it and it's nice, but they don't provide an example with real parameters, just what the endpoint accepts and returns:

But it doesn't say how then GET request should be shaped (the actual string that you type either in the browser or in curl)

dnil commented 3 years ago

Also, I would rather say its a patch, for just extending docs? Changing that, but protest if you disagree obviously!

northwestwitch commented 3 years ago

Also, I would rather say its a patch, for just extending docs? Changing that, but protest if you disagree obviously!

Doesn't really matter, patch is good!

northwestwitch commented 3 years ago

Merged as a patch, thanks @dnil!