search

BRCAChallenge / brca-exchange

Overall management and deployment of the BRCA Exchange web portal and pipeline scripts
http://brcaexchange.org
28 stars 32 forks source link

Add a landing page to API endpoint (like ref server) #427

Open wdesouza opened 7 years ago

wdesouza commented 7 years ago

I am trying to access the GA4GH-based BRCA server endpoint (http://brcaexchange.org/backend/data/ga4gh/v0.6.0a7/). It seems to be not available anymore. Did the server URL changed?

The URL in iPython notebook is also not working (http://brca-exchange.org/backend/data/ga4gh/v0.6.0a7/).

david4096 commented 7 years ago

Hi @Welliton309! Spotted a typo, thank you! The URL in the notebook should NOT have a -.

I was able to access the resource using the following curl request. Please let me know if you're successful.

curl -X POST --data '{"referenceName": "17", "start": 1000000, "end": 121212121212, "variantSetId": "brca-hg37"}' http://brcaexchange.org/backend/data/ga4gh/v0.6.0a7/variants/search -H "Content-Type: application/json"

I opened #428 to fix the typo!

wdesouza commented 7 years ago

Thank you @david4096 I thought that the server wasn't available because I expected a landing page (my fault).

david4096 commented 7 years ago

Ahh, yeah, that would be a nice feature if the landing page served swagger UI, or at least some text! The BRCA exchange does not use the same software as the reference server so we would have to add it.

david4096 commented 7 years ago

It involves adding a route here https://github.com/BD2KGenomics/brca-exchange/tree/master/website/django/data

And adding a view to go with it here https://github.com/BD2KGenomics/brca-exchange/blob/master/website/django/data/views.py

david4096 commented 7 years ago

Thank you @david4096 I thought that the server wasn't available because I expected a landing page (my fault).

Mind if I reopen to track the addition of this feature? I don't mind it being a separate issue if you like!