JSON Schemas
One generated JSON Schema per wire (frontend 5, Admin 6, decision.v1) from crates/protocol, drift-tested.
Living doc, checked against the code 2026-11-14
One JSON Schema (draft-07) per wire, generated from the Rust types in crates/protocol; ts-rs turns the same types
into packages/protocol/src/generated. A client in any language can generate its models from these files. A
compatibility checker that diffs them between builds is planned, not built.
What is here
| file | wire | stability | each frame is |
|---|---|---|---|
frontend.v5.schema.json |
the frontend WebSocket, protocol 5 (frontend.v5) | public | a ClientControl (frontend to gateway) or a ServerEvent (gateway to frontend) |
admin.v6.schema.json |
the Admin owner socket, protocol 6 (admin.v6) | owner | an AdminRequest or an AdminResponse |
decision.v1.schema.json |
decision.v1, an HTTP POST | public | a DecisionRequest or a DecisionAnswer |
Each document’s root accepts one frame from either direction. Its x-vulpine block names the root type per
direction (frames), the version, the transport, the stability label and how a reader should treat it (reading).
The schema is the writer’s view of this build. A reader stays as lenient as the Rust types: unknown members are
ignored, and an enum with a catch-all word accepts new words. Descriptions are the Rust doc comments.
Run and test
The files are generated. Never edit them by hand.
See also
- contracts: the prose contracts. Each schema has one beside it that names every frame.