Skip to content

update endpoint docs

Marek Szuba requested to merge github/fork/ima23/update_docs_m into master

Created by: ima23

Copy of PR (release/98) now on master


Using one or more sentences, describe in detail the proposed changes.

One more VEP plugin will be available through the VEP endpoint. The documentation in this PR is needed for the plugin. The corresponding parameters config are in PR

Use case

Describe the problem. Please provide an example representing the motivation behind the need for having these changes in place.

Plugin functionality available through REST.

live: sandbox:


If applicable, describe the advantages the changes will have.

Without this documentation, the endpoint will not display the availability of the functionality in the background.

Possible Drawbacks

If applicable, describe any possible undesirable consequence of the changes.


Have you added/modified unit tests to test the changes? No tests added. Local test server page checked manually.

If so, do the tests pass/fail? pass

Have you run the entire test suite and no regression was detected? No change to code. Test ran.

Tested : http://hx-noah-74-15:3000/vep/human/id/rs699?content-type=application/json;CADD=1


Are you changing the functionality of an endpoint? If so, please give a one line summary for the public facing changelog.

[/vep/:species/hgvs/] new plugin option added: CADD [/vep/:species/id/] new plugin option added: CADD [/vep/:species/region/] new plugin option added: CADD

Merge request reports