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 C
Builders treat schemas as versioned contracts alongside HTTP route catalogs

Workflow

  1. Change Python envelopes first, then schema.
  2. Update matching sample-*.json.
  3. Run pytest tests/test_docs_schemas.py.

Additional machine-generated artifacts refreshed by scripts/check-docs.sh for auditors:

  • docs/generated/schema-index.jsongenerator/export_schema_index.py indexes every .schema.json file.
  • docs/generated/openapi.jsongenerator/export_openapi.py mirrors docs/generated/api-routes.json with partial path coverage (not authoritative OpenAPI parity yet — read Builders — OpenAPI).

Verify

CI passes on test_docs_schemas after your schema edit.

What to do next