vibesketch.document.schema

The JSON schema of the document, generated from the model.

schema/vibe-sketch-1.schema.json is this function’s output, committed so that clients outside Python (the browser shell, other programs) can validate a .vsk without the package. vibe-sketch schema --output regenerates it; tests/test_document_schema.py fails when the two drift apart.

Module Attributes

SCHEMA_URI

Where the schema is published once the documentation site is.

SCHEMA_FILE

The committed file, relative to the repository root.

Functions

document_json_schema()

The JSON schema (draft 2020-12) of a version-1 document.

vibesketch.document.schema.SCHEMA_URI = 'https://vibe-qc.com/vibe-sketch/schema/vibe-sketch-1.schema.json'

Where the schema is published once the documentation site is.

vibesketch.document.schema.SCHEMA_FILE = 'schema/vibe-sketch-1.schema.json'

The committed file, relative to the repository root.

vibesketch.document.schema.document_json_schema()

The JSON schema (draft 2020-12) of a version-1 document.

Return type:

dict[str, Any]