VFX-D-1101¶
Title¶
SchemaViolation
Explanation¶
A field in the suite violates the engine's JSON Schema — a genuine structural error, found by
evaluating the suite against the embedded vendored composed schema (the same schema the real engine
validates against). Reported as data on a successful validate_suite/run_suite call.
Common causes¶
- A required field is missing on a step or at the suite root.
- A field's value has the wrong JSON type (e.g. a string where the schema expects an integer, or an object where it expects an array).
- An enum-constrained field (e.g.
verifyMode) carries a value outside its allowed set.
Fixes¶
- Use the finding's
instancePathandline/columnto locate the offending field. - One caveat on
instancePath: it is rendered for DISPLAY, with control characters and non-ASCII shown as literal\uXXXXescapes, so a pointer passing through a key that contains such a character will not match the document's own text verbatim — treat it as a description of the location, never as a lookup key.line/columnremain exact either way. - Compare the field's expected shape against the language reference (
vouchfx-docs:///language-reference, orsearch_docsfor the relevant step type). - Fix all reported violations and re-run
validate_suite— every violation is reported in one pass, not one at a time.