Handbook
Builders — JSON schemas
docs/schemas/ holds JSON Schema files checked by tests/test_docs_schemas.py. Companion samples live in docs/examples/ and are indexed from JSON examples hub.
Updated
What it is
docs/schemas/ holds JSON Schema files checked by tests/test_docs_schemas.py. Companion samples live in docs/examples/ and are indexed from JSON examples hub.
What it is
Root / intake
+-- branch A
+-- branch B
+-- branch CWorkflow
- Change Python envelopes first, then schema.
- Update matching
sample-*.json. - Run
pytest tests/test_docs_schemas.py.
Additional machine-generated artifacts refreshed by scripts/check-docs.sh for auditors:
docs/generated/schema-index.json—generator/export_schema_index.pyindexes every.schema.jsonfile.docs/generated/openapi.json—generator/export_openapi.pymirrorsdocs/generated/api-routes.jsonwith partial path coverage (not authoritative OpenAPI parity yet — read Builders — OpenAPI).
Verify
CI passes on test_docs_schemas after your schema edit.