Compatibility

A bundle schema must use the GKM product versions supported by the installed ga4gh.gkm release. Loading fails when a recognized GKM schema reference uses a different version.

Supported product versions

ga4gh.gkm currently supports:

GKM product	Supported version
`gkm-core`	`1.3.0`
`vrs`	`2.1.1`
`cat-vrs`	`1.1.1`
`va-spec`	`1.1.0`

The table is generated during the documentation build from ga4gh.gkm.bundles.supported_gkm_versions().

API

compatibility

Compatibility checks for GKM product schemas.

Functions:

supported_gkm_versions

supported_gkm_versions() -> dict[str, str]

Return the latest GKM product versions supported by this installation.

Returns:

Type	Description
`dict[str, str]`	Product names mapped to their supported schema versions.

w3id_schema_reference

w3id_schema_reference(reference: str) -> Match[str] | None

Match a supported-product GA4GH W3ID schema reference.

Parameters:

Name	Type	Description	Default
`reference`	`str`	Schema reference URL.	required

Returns:

Type	Description
`Match[str] \| None`	The product and version match, or `None` for another reference.

check_gkm_version_compatibility

check_gkm_version_compatibility(schema: Mapping[str, Any]) -> None

Check GKM W3ID references against installed product versions.

Each recognized reference must exactly match the version reported by :func:supported_gkm_versions.

References outside the versioned GA4GH W3ID schema namespace are ignored.

Parameters:

Name	Type	Description	Default
`schema`	`Mapping[str, Any]`	Producer JSON Schema to inspect.	required

Raises:

Type	Description
`BundleCompatibilityError`	If a GKM schema version does not match the installed reference implementation.