Schema Reference
Schema Reference
Section titled “Schema Reference”OpenTrackPlan uses YAML files for configuration. This section covers all file formats.
File Types
Section titled “File Types”| File | Purpose | Schema |
|---|---|---|
opentp.yaml | Main configuration | opentp.schema.json |
events/*.yaml | Event definitions | event.schema.json |
dictionaries/*.yaml | Reusable value lists | dict.schema.json |
JSON Schemas
Section titled “JSON Schemas”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/opentp.schema.jsonSchema URLs
Section titled “Schema URLs”| Schema | URL |
|---|---|
| Main config | https://opentp.dev/schemas/opentp.schema.json |
| Events | https://opentp.dev/schemas/event.schema.json |
| Dictionaries | https://opentp.dev/schemas/dict.schema.json |
| Field (shared) | https://opentp.dev/schemas/field.schema.json |
| Version (shared) | https://opentp.dev/schemas/version.schema.json |
Version
Section titled “Version”All OpenTrackPlan files start with:
opentp: 2025-06This declares the format version for compatibility.