Skip to content

/versions

Purpose

Returns the software, library, and reference dataset versions used by the VariantValidator SHAIP service.

This endpoint supports:

  • Reproducibility of analyses
  • Debugging differences between environments
  • Tracking updates to underlying tools and reference data

Method

GET

Request

No parameters are required.

GET /versions

Response

Returns a JSON object containing metadata describing the runtime versions of all core components and data resources.

Example Response

{
  "metadata": {
    "variantvalidator_hgvs_version": "4.0.0",
    "variantvalidator_version": "4.0.0",
    "vvdb_version": "vvdb_2025_3",
    "vvseqrepo_db": "VV_SR_2025_02/master",
    "vvta_version": "vvta_2025_02"
  }
}

Field Descriptions

Field Description
variantvalidator_hgvs_version Version of the HGVS parsing/handling layer
variantvalidator_version Core VariantValidator engine version
vvdb_version VariantValidator database release used internally
vvseqrepo_db SeqRepo dataset version and branch
vvta_version Transcript annotation dataset version

Behaviour

  • Returns current runtime metadata for all core components
  • No input validation required
  • Lightweight and suitable for monitoring or pipeline checks
  • Always reflects the actively loaded datasets and software

When to Use

Use /versions:

  • Before running large or production analyses
  • When comparing outputs across systems or releases
  • During debugging or issue reporting
  • To document provenance in pipelines

Notes

  • Variations in vvdb, vvseqrepo, and vvta versions can affect results
  • Version identifiers correspond to loaded runtime data, not installation history
  • Output structure is stable but additional fields may be introduced in future releases