Spec / open-values-category-dataset
Open Values Category Dataset v0.1
A built app-ready category dataset generated from a source lens or open-data pipeline.
- Files built from other files
- Status: stable
- Version: none
- Format name in the file:
open-values-category-dataset
Stable. A change that breaks existing files needs a new version. A file a build step makes from other files. Change the sources, not this file.
Who writes it and who reads it
Written by pipeline/build_datasets.py. Read by app data loader, Ask, verdict cards, linked-data export.
Fields
This schema lists no named fields; see the schema file for its shape.
A reader MUST ignore fields it does not know, so a file can carry more than this list and still be read. A writer MUST NOT change what a listed field means.
A file that passes
Generated category datasets use the lens contract.
{
"meta": {
"id": "sample-category",
"label": "Sample category",
"type": "Products",
"source": "Conformance fixture"
},
"criteria": [
{
"key": "environment",
"label": "Environment"
}
],
"products": [
{
"code": "sample-item",
"name": "Sample Item",
"scores": {
"environment": 75
},
"provenance": {
"environment": "Fixture source."
}
}
]
}
The schema
Its address is https://openvaluesstandard.org/schema/category-dataset-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/category-dataset.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.