Skip to documentation content
Dataset APIDocs

Immutable releases

Select, validate, and retain reproducible dataset snapshots.

In this guide
  1. 1Inspect manifests
  2. 2Gate on quality
  3. 3Preserve lineage
  4. 4Choose a release policy
In this guide
  1. 1Inspect manifests
  2. 2Gate on quality
  3. 3Preserve lineage
  4. 4Choose a release policy

Inspect the release manifest

GET /v1/datasets/{dataset_id}/releases/{release_id}

Require matching dataset_id, the expected schema_version, and immutable=true. Record dataset_version and definition_version so downstream incidents can be traced to both data and definition changes.

Gate explicitly on quality

quality_statusMeaningRecommended default
completeConfigured source coverage and validation completed for the releaseAccept
partialCoverage or validation is incompleteQuarantine unless the use case explicitly permits partial data

Preserve parent lineage

parent_release_id links a release to its predecessor when available. Use it to explain deltas, detect a broken chain, and show which release an import replaced. A null parent identifies a root or a release without declared parent lineage.

Choose a release policy

PolicyUse whenTrade-off
Pinned release IDReproducibility is mandatoryRequires an explicit upgrade
Latest completeFreshness matters and partial data is unacceptableResults change when a new complete release appears
Latest including partialCoverage gaps are acceptable and visibleEvery consumer must handle partial data

Own your retention requirement

Was this page helpful?