Skip to main content
schema: 1

Type

integer

Required

Recommended. If omitted, gaal assumes schema: 1 and prints a deprecation warning. A future release may require it.

Allowed values

ValueStatus
1The current and stable schema. All gaal features documented on this site read and write schema: 1 files.

Stability guarantee

schema: 1 is stable forever. Future gaal releases will continue to read it. When a breaking change is necessary, gaal will introduce schema: 2 with a documented migration path. Existing schema: 1 files will not be silently broken.

Why it’s at the top

Putting schema: at the top makes the file self-describing. A tool reading gaal.yaml (your editor, a linter, a CI check) can branch on the value before parsing the rest.

Schema overview

The gaal.yaml file