Skip to content

Extensions

Any mapping in the file may carry keys that start with x-. A reader keeps them and may show them verbatim; no check looks at their content. Use them for team conventions or experiments. Any other unknown key is an error, which catches typos such as purpse.

Example

datasets:
  Rents:
    x-team-note: reviewed by the data desk
    columns:
      rent:
        description: asking rent
        x-source-field: RENT_ASK

Definitions

Key Type Required Priority Check Description
x-<anything> any YAML value no None - Allowed at every level. Kept with its source text.
any other unknown key - - None error (unknown key) Reported with the file line.

The JSON Schema expresses this with additionalProperties: false and patternProperties: {"^x-": {}}.