-
Notifications
You must be signed in to change notification settings - Fork 21
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
genes2transcripts
output was altered and all interactions now fail
#579
Comments
13 tasks
ifokkema
added a commit
to LOVDnl/LOVD3
that referenced
this issue
Jan 23, 2024
VV's output changed, and our calls to the API were failing. openvar/variantValidator#579 Now handling both the original output and the new output. The additional code can later be removed in case VV will fix the above issue by reverting the changes to their API.
This is odd. I don't remember making the V1 version into a list output. It is the sort of breaking change we aviod. Leave it with me, |
@ifokkema , this was a change in VariantValidator not the API. Restoring old behavior |
Peter-J-Freeman
added a commit
to openvar/rest_variantValidator
that referenced
this issue
Feb 16, 2024
This is fixed. Needs a server update now @ifokkema |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
The
genes2transcripts
output was altered, and all interactions now fail.Until now, LOVD3 allowed using VV to retrieve transcripts for a gene as a backup of the existing Mutalyzer feature, which has increasingly been failing. I've been putting off the work needed to remove Mutalyzer altogether, but I'm now in the process of doing so. However, to my surprise, the VV feature to fetch transcripts no longer worked because the API's output was changed recently. I can't be sure which commit caused this, as I'm unfamiliar with VV's internal structure, but the whole response is now wrapped into an otherwise empty list. I can only assume this concerns #515 and #516. If I had done the work earlier, this would have broken all LOVD instances worldwide.
Although a
genes2transcripts_v2
endpoint suggests that some form of versioning is now in use, I must stress again never to change existing API output (although adding fields to an existing API structure would be acceptable, in my opinion). Tests must be in place to ensure that existing API endpoints don't lose existing fields or, in this case, even return a completely different type of variable (from object to list).To Reproduce
Steps to reproduce the behavior:
Used to return an object:
However, it now returns a list:
Expected behavior
Since I'll need to continue development, I'll add a workaround in the LOVD3 code. Related issue: LOVDnl/LOVD3#639
However, although I don't know how long this has been broken, I suggest restoring the original output to avoid breaking other implementations out there. Also, I believe the v1 of the endpoint isn't meant to process a list of genes anyway, so the list in the output doesn't apply altogether and will just confuse new users.
Note, I'm completely fine with a list as a return value for the v2 of the endpoint, and it makes sense there, as it allows for a list to be submitted.
The text was updated successfully, but these errors were encountered: