Skip to content

Schema

OpenTrackPlan uses YAML files for configuration. This section covers all file formats.

FilePurposeSchema
opentp.yamlMain configurationopentp.schema.json
events/*.yamlEvent definitionsevent.schema.json
dictionaries/*.yamlReusable value listsdict.schema.json

All file formats have JSON schemas for IDE validation and autocompletion.

Add this comment at the top of your YAML files:

# yaml-language-server: $schema=https://opentp.dev/schemas/latest/opentp.schema.json
SchemaURL
Main confighttps://opentp.dev/schemas/latest/opentp.schema.json
Eventshttps://opentp.dev/schemas/latest/event.schema.json
Dictionarieshttps://opentp.dev/schemas/latest/dict.schema.json
Field (shared)https://opentp.dev/schemas/latest/field.schema.json
Version (shared)https://opentp.dev/schemas/latest/version.schema.json

All OpenTrackPlan files start with:

opentp: 2025-12

This declares the format version for compatibility.