Rename /reverse_lookup?curies=X to /synonyms?preferred_curie=X
#136
Milestone
Comments
gaurav
added a commit
that referenced
this issue
Oct 16, 2024
gaurav
added a commit
that referenced
this issue
Nov 4, 2024
We've had a lot of users getting confused because a CURIE that works in NodeNorm doesn't work in NameLookup -- this is because NameLookup's `/reverse_lookup` endpoint doesn't do any normalization. This PR deprecates those endpoints (while leaving them around), and adds new `/synonyms` endpoints, which explicitly call them `preferred_curies` and has a note in the description to indicate that NodeNorm should be used to get these. `/synonyms` isn't quite accurate, because really this endpoint returns all the information we have on that CURIE, including the suffix, taxon information and so on. But the obvious correct name (`/lookup`) is already in use for NameLookup's text search function. Closes #136.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We've had several users this week who expected that
/reverse_lookupwould normalize the incoming CURIE as well, and being surprised when a secondary CURIE didn't work on NameRes without normalizing it through NodeNorm first. Renaming this to/synonyms?preferred_curie=Xmight make this clearer. We could also improve the documentation to make this clearer.If/when we have a NameRes FAQ or a combined NodeNorm/NameRes Jupyter Notebook (#133), this might also be usefully explained there.
The text was updated successfully, but these errors were encountered: