Spec / open-values-conformance-vectors
Open Values Conformance Vectors v0.1
A set of small example files for testing a reader or validator of Open Values formats. Each example names a format, gives a value, and says whether that value should pass or fail. The project keeps it by hand at app/data/standard/conformance-vectors.json; the standard audit runs every example, and the spec pages show them.
- Test data and building contracts
- Status: draft
- Version: 0.1.0
- Format name in the file:
open-values-conformance-vectors
Draft. It may still change before it is called stable. Data kept for tests, not for use.
Who writes it and who reads it
No writer is listed. Read by audit:standard, future implementer test suites, research/standard_audit.js, pipeline/build_kit.js.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-conformance-vectors". Tells a reader which Open Values format this is. | always "open-values-conformance-vectors" |
version required | The version of this format the file follows, as a semantic version such as "0.1.0". | string |
standard required | Always "open-values-standard", the standard the examples test. | always "open-values-standard" |
standardVersion required | The version of the Open Values Standard the examples were written for, such as "1.0.0-draft.1". | string |
updated required | The date the file was last changed, as YYYY-MM-DD. | string |
description | A sentence saying what this set of examples covers. | string |
vectors required | The examples, one entry each. At least one. | 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/conformance-vectors-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/conformance-vectors.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.