biothings / biothings_explorer

TRAPI service for BioThings Explorer
https://explorer.biothings.io
Apache License 2.0
10 stars 11 forks source link

Augment WikiPathways OpenAPI info with `x-bte` information #435

Open andrewsu opened 2 years ago

andrewsu commented 2 years ago

WikiPathways is a valuable resource for information on biological pathways. We should annotate the API using the x-bte extensions so it can be called within BioThings Explorer.

These are example API calls:

(*) @ariutta I would have thought these two API calls would work based the pattern for gene mappings and the table of ID abbreviations you sent, but they are not currently returning results. Metabolites with Pubchem-compound IDs are found on https://www.wikipathways.org/index.php/Pathway:WP5064. Can you review please?

Presumably after the appropriate x-bte annotations are defined here, this issue would result in a PR to the Wikipathways code that generates that swagger / Open API content.

Relevant links:

colleenXu commented 2 years ago

I'll review the Metabolite -> Pathway and Pathway -> Metabolite links once we figure those out.


Some questions:

colleenXu commented 2 years ago

I'll also note that the current swagger link seems to be written in an older standard (2.0?) that I'm not familiar with.

I guess I'm familiar with OpenAPI 3.0, so I'd probably be more comfortable rewriting the file to OpenAPI 3.0 / SmartAPI before adding x-bte annotation...

ariutta commented 2 years ago

Our colleagues in the Netherlands are in the process of updating the webservice API. We can connect you with them if you think it’d be useful to discuss OpenAPI 3.0.

We also have an RDF endpoint that should be able to return everything needed, e.g., here's an example query for getting all pathways with a specific gene.

Alternatively, we’re happy to provide a monthly flat file. For just genes, the GMT is enough, but for ontology terms or metabolites, it'd probably make sense to create a new file.

ariutta commented 2 years ago

@colleenXu, I sent an update by email, but I'll copy it over here too:

I talked with Egon and some other folks from Maastricht today, and they said let's go ahead with the update based on the existing API. Egon created a GitHub repo for the current API definition here: https://github.com/wikipathways/openapi/blob/main/openapi.json

Colleen, if you want to make a pull request, you can feel free to add x-bte annotations and any other updates as required.

colleenXu commented 2 years ago

@ariutta Thank you, I've seen the email. I have a plan to review that link and make a fork to write a openapi v3 version with x-bte annotation.

Just need to get around to getting it done >.<