Enrichment Sidecar

Enrichment Sidecar

Schema for enrichment YAML sidecar files that capture domain knowledge about spatial datasets — field renames, descriptions, value labels, and column ordering.

This schema defines 7 fields (1 required, 6 optional).

Fields

Field	Type	Required	Description	Constraints
layer_id	string	Yes	Layer identifier matching the pipeline stage layer.id	-
source	string	No	Human-readable source dataset name (e.g., ‘Landgate Cadastre’)	-
schema_hash	string	No	SHA-256 hash of the source dataset schema at enrichment creation time	Pattern: ^[a-f0-9]{64}$
column_renames	object: {string: string}	No	Map of source column name to human-readable name	-
descriptions	object: {string: string}	No	Map of column name to human-readable description	-
value_labels	object: {string: {string: string}}	No	Map of column name to {coded_value: label} mappings for creating human-readable label columns	-
column_order	array of string	No	Preferred output column ordering (use enriched/renamed column names)	-

Pattern: Value Labels

The value_labels field uses a map-of-maps pattern. The outer keys are column names, and the inner keys are coded values mapped to human-readable labels.

value_labels:
  zone_code:
    R20: "Residential R20"
    C1: "Commercial C1"
  tenure_type:
    F: "Freehold"
    C: "Crown"