Spec / open-values-presentation-fixtures
Open Values Presentation Fixtures v1.0
Test cases for the shared page layer: for each of the ten page kinds, one real page with good sources, one with gaps, and one not covered yet, with what each page must and must not show. Maintainers write them, and the presentation build checks every case still points at real data.
- Test data and building contracts
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-presentation-fixtures
Draft. It may still change before it is called stable. Data kept for tests, not for use.
Who writes it and who reads it
Written by pipeline/build_presentation.js. Read by P5 presentation renderer snapshots, presentation acceptance audit.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-presentation-fixtures. | always "open-values-presentation-fixtures" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
updated required | The date the fixtures were last changed, as YYYY-MM-DD. | string |
states required | The three coverage states every page kind is tested in, in this order: rich, thin and not-yet-covered. | always ["rich","thin","not-yet-covered"] |
fixtureSets required | One set of test cases per page kind, in the same order as the page kinds file. | list |
This format allows no fields beyond the list above. A writer MUST NOT add any.
The schema
Its address is https://openvaluesstandard.org/schema/presentation-fixtures-v1.0.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/presentation-fixtures.schema.json.
The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.
Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.