Skip to content

JSON Schema

Machine-readable JSON Schema files are available for all three weevr configuration types. These schemas are generated from the Pydantic models that the engine uses for validation, so they always reflect the accepted configuration surface.

Schema Files

File Description
thread.json Thread configuration
weave.json Weave configuration
loom.json Loom configuration
weevr.json Combined (all three)
warp.json Warp schema contract

Usage with LLMs

Paste the contents of weevr.json into your LLM context to enable accurate YAML generation. For a curated reference document with examples, see llms-full.txt.

Usage with IDE Extensions

Many YAML editor extensions support JSON Schema for autocompletion and validation. Point the extension at the raw GitHub URL for the relevant schema file:

https://raw.githubusercontent.com/ardent-data/weevr/main/docs/schema/thread.json

Regenerating

Schemas are committed as static files and verified by CI. To regenerate after model changes:

python scripts/generate_schema.py

To check if schemas are up-to-date without writing:

python scripts/generate_schema.py --check