Skip to content

API reference

The API reference documents the public classes, functions, and exceptions in ga4gh.gkm.bundles.

  • Containers — inspect collections, resolve references, and serialize bundles.
  • Loading — load one or several bundles from files, streams, registered names, or the public bundle repository.
  • Pointers — validate bundle-local JSON Pointers.
  • Schema validation — validate bundles against their Draft 2020-12 producer schemas.
  • Schema resolution — find the schema node and external reference for a bundle-local pointer target.
  • Model conversion — convert bundle values to installed GA4GH models.
  • Compatibility — view supported GKM product versions and check a producer's bundle schema.
  • Registry — associate names with bundle and schema sources.
  • Bundle repository — retrieve bundles and schemas from the canonical public R2 repository.
  • Errors — package-specific exception hierarchy.