Skip to content

For validation and completion in your editor, add this first line to the file (YAML language server, used by VS Code and others):

# yaml-language-server: $schema=https://docs.caplo.si/schemas/fixture.schema.json

The schema is also published at /schemas/fixture.schema.json.

Field Type Required Description
name string At most 200 characters.
tool string Yes Pattern ^[a-z][a-z0-9_]{0,47}$.
arguments object Yes
secrets object Test values for declared secrets.
expect object Yes See expect.

Other fields are refused.

Field Type Required Description
isError boolean
structuredContent object Every listed field must equal the result’s field; extra result fields are allowed.
textIncludes string Substring of the joined text content.

Other fields are refused.