Spec / open-values-ontology
Open Values Ontology v0.4
The menu people browse the catalogue by: eight human needs, and the areas of life with their categories, each category tagged with a need and linked to its facts file once one is built. Conscious Consuming keeps it.
- Files people or tools write
- Status: stable
- Version: 4
- Format name in the file:
open-values-ontology
Stable. A change that breaks existing files needs a new version. A file someone writes by hand or with a tool, and keeps.
Who writes it and who reads it
Written by pipeline/build_datasets.py, pipeline/mature_ontology.py. Read by Round 11 needs map, app browse tree, app/data/index.json, public routes.
Fields
| Field | What it means | Type |
|---|---|---|
version required | The version of this navigation file, as a whole number. The current file is version 4. | integer |
note | A paragraph for maintainers explaining how the file is organised and what changed in this version. | string |
types required | The kinds of thing an entry can be: Products, Services, Media, Organizations and Initiatives. Each category names one of these. | list |
needs required | The eight human needs that people browse by first, such as nourish or move, each with a short sentence saying what it covers. | list |
domains required | The areas of life, such as "Food & drink", each with its list of categories. Every category appears here exactly once. | list |
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
A v4 ontology has eight needs plus typed categories in its compatibility domains.
{
"version": 4,
"types": [
"Products",
"Services"
],
"needs": [
{
"id": "nourish",
"label": "NOURISH",
"reads": "Food and drink."
},
{
"id": "care",
"label": "CARE",
"reads": "Bodies and wellbeing."
},
{
"id": "keep-a-home",
"label": "KEEP A HOME",
"reads": "A working home."
},
{
"id": "connect",
"label": "CONNECT",
"reads": "People and services."
},
{
"id": "move",
"label": "MOVE",
"reads": "Journeys and transport."
},
{
"id": "learn",
"label": "LEARN",
"reads": "Knowledge and media."
},
{
"id": "give-and-act",
"label": "GIVE & ACT",
"reads": "Causes and action."
},
{
"id": "protect",
"label": "PROTECT",
"reads": "Money and security."
}
],
"domains": [
{
"label": "Food",
"categories": [
{
"label": "Tea",
"cid": "tea",
"type": "Products",
"group": "Drinks",
"need": "nourish"
}
]
}
]
}
A file that must be rejected
Ontology category types must use the known entry-type enum.
{
"version": 3,
"types": [
"Products"
],
"domains": [
{
"label": "Food",
"categories": [
{
"label": "Tea",
"cid": "tea",
"type": "Stuff"
}
]
}
]
}
The schema
Its address is https://openvaluesstandard.org/schema/ontology-v0.4.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/ontology.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.