Slot: Schema Version (schema_version)
The version of the EnVar micro-schema this document conforms to. Required on every sidecar so downstream consumers can branch on schema evolution.
Tier: core
Why this slot matters
Downstream consumers must branch on schema evolution: a parser built for one version will silently misread or wrongly reject sidecars written against another. Without this slot there is no way to tell which iteration of the schema a document targets.
In plain terms
Schemas change over time, like editions of a paper form. This is the edition number stamped on the document, so anyone reading it knows exactly which version of the form was filled in and can interpret the fields accordingly.
URI: envar:slot/schema_version
Applicable Classes
Properties
Type and Range
Cardinality and Requirements
| Property |
Value |
| Required |
Yes |
Examples
See Also
Annotations
| property |
value |
| tier |
core |
| justification |
Downstream consumers must branch on schema evolution: a parser built for one version will silently misread or wrongly reject sidecars written against another. Without this slot there is no way to tell which iteration of the schema a document targets. |
| explanation |
Schemas change over time, like editions of a paper form. This is the edition number stamped on the document, so anyone reading it knows exactly which version of the form was filled in and can interpret the fields accordingly. |
| covered_by |
None |
Schema Source
Mappings
| Mapping Type |
Mapped Value |
| self |
envar:schema_version |
| native |
envar:schema_version |
LinkML Source
name: schema_version
annotations:
tier:
tag: tier
value: core
justification:
tag: justification
value: 'Downstream consumers must branch on schema evolution: a parser built for
one version will silently misread or wrongly reject sidecars written against
another. Without this slot there is no way to tell which iteration of the schema
a document targets.'
explanation:
tag: explanation
value: Schemas change over time, like editions of a paper form. This is the edition
number stamped on the document, so anyone reading it knows exactly which version
of the form was filled in and can interpret the fields accordingly.
covered_by:
tag: covered_by
annotations:
omop_gaia:
tag: omop_gaia
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: No native gaia output carries a sidecar schema-version field; this
is an EnVar-sidecar-level construct.
degauss:
tag: degauss
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: DeGAUSS produces no metadata sidecar and carries no schema-version
field.
amadeus:
tag: amadeus
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Amadeus's native metadata carries no sidecar schema-version field.
cher:
tag: cher
annotations:
extent:
tag: extent
value: absent
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: C-HER's version code versions the data resource, not a metadata
sidecar schema, so no EnVar-style schema-version field exists.
codata:
tag: codata
annotations:
extent:
tag: extent
value: out_of_layer
status:
tag: status
value: asserted
where:
tag: where
value: no column
note:
tag: note
value: Sidecar schema versioning is packaging-layer; out of scope for
CODATA's conceptual framework.
description: The version of the EnVar micro-schema this document conforms to. Required
on every sidecar so downstream consumers can branch on schema evolution.
title: Schema Version
examples:
- value: '0.1'
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://semver.org/
rank: 1000
domain_of:
- EnvironmentalExposureRecord
range: string
required: true