Skip to content

Unified YAML Schema

Data Caterer provides a JSON Schema for the unified YAML format to enable IDE autocomplete and validation.

Schema File

  • Schema URL: https://raw.githubusercontent.com/data-catering/data-caterer/main/misc/schema/unified-config-schema.json
  • Examples: Unified YAML examples

IDE Autocomplete

Add a schema reference at the top of your YAML file:

# yaml-language-server: $schema=https://raw.githubusercontent.com/data-catering/data-caterer/main/misc/schema/unified-config-schema.json
version: "1.0"
name: "my_plan"
dataSources: []

CLI Validation

Validate a file locally using check-jsonschema:

pip install check-jsonschema
check-jsonschema --schemafile misc/schema/unified-config-schema.json your-config.yaml