REST VariantValidator2 (SHAIP)¶
REST VariantValidator2 (SHAIP) is the current-generation REST API for VariantValidator.
Built using FastAPI and Python 3.12, REST VariantValidator2 provides a modern, high-performance interface to the VariantValidator framework, supporting automated variant validation, formatting, transcript mapping and scalable bioinformatics workflows.
REST VariantValidator2 is intended for production deployments, cloud-native applications and high-throughput pipeline integration.
Repository access¶
The REST VariantValidator2 source repository is private and will not be made publicly accessible.
Users interact with REST VariantValidator2 through the hosted service and the official documentation rather than through the source repository.
Requesting access¶
Access to the hosted REST VariantValidator2 service requires a user account.
Instructions for requesting an account, activating access and obtaining API credentials are provided in the official REST VariantValidator2 documentation.
If you require assistance with account activation or access requests, please contact the VariantValidator development team:
admin@variantvalidator.org
Documentation¶
The complete REST VariantValidator2 documentation is maintained separately using MkDocs.
The documentation includes:
- account creation and authentication;
- installation and deployment;
- Docker configuration;
- API endpoint reference;
- request and response examples;
- developer guides;
- release notes; and
- operational guidance.
Official REST VariantValidator2 documentation:
https://openvar.github.io/rest_variantValidator2/
Related documentation¶
The following VariantValidator documentation may also be useful:
- REST VariantValidator
- VariantValidator Web Interface (VVweb)
- VariantValidator Python API
- VariantFormatter Python API
- Supported Input Formats
- Transcript Selection
- Output Formats
- Errors and Error Codes
How to cite VariantValidator¶
If you use VariantValidator in your research, please cite the appropriate VariantValidator publication(s).
Acknowledgements¶
VariantValidator was originally developed at the University of Leicester (2016–2019). It is now maintained and developed by the University of Manchester, with continued hosting and development contributions from the University of Leicester.
