Schemas¶
The JSON schemas that define benchx's documents. Every component produces or consumes one of these; the design documents explain the reasoning behind each.
| Schema | Version | Defines |
|---|---|---|
| BenchX comparison document | 0.1.0 | The comparator's output: verdicts for target results against their references, in history mode or run mode, with the evidence behind each. |
| BenchX project configuration | 0.1.0 | benchx.conf.json, in the project root: how this project is measured. |
| BenchX environment identity | 0.1.0 | The shape of coordinates.environment when coordinates.environment.schema_version is "benchx/env-identity/0.1.0" (docs/design/runner-schema.md §5.2). |
| BenchX environment policy | 0.1.0 | A named, versioned list of rules the runner enforces, verifies, or records before and during a run (docs/design/runner-schema.md §4). |
| BenchX identity policy | 0.1.0 | A project's identity policy (docs/design/benchmark-result-schema.md section 4.3): for every reported fact, whether it must match, as is or normalized, for two results to share a series, or is ignored. |
| BenchX measurement result ingest object | 0.1.0 | One measurement attempt for one quantity and one workload variant, as reported by a producer. |
| BenchX target description | 0.1.0 | What a target provider hands the workbench about one prepared target (docs/design/system-decomposition.md §3.4). |
| BenchX target provider request | 0.1.0 | What the workbench writes to a target provider's stdin (docs/design/system-decomposition.md §3.4). |
| BenchX work order | 0.1.0 | The runner's single input: what to run, at what, how, and for whom (docs/design/runner-schema.md §3). |
Each page links the raw schema.json and its examples. Schemas are validated by the implementation's bx validate.