Spec / ovs-node-page-contracts
Open Values Node Page Contracts v0.1
For each kind of page on the site (category, entry, guide, brand, company, label, errand, line), its address pattern, where its data comes from, which fields it needs, and the sections it shows. The data build writes it for the people building those pages. It is an internal file used while building the site.
- Test data and building contracts
- Status: dev-contract
- Version: 0.1
- Format name in the file:
ovs-node-page-contracts
Used while building the sites. Not meant for other apps. Data kept for tests, not for use.
Who writes it and who reads it
Written by pipeline/build_nodes.js. Read by app-lane integration, public route planning.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names this file's format, so a reader can check it before reading the rest of the file. | always "ovs-node-page-contracts" |
version required | The version of the format this file follows, such as "0.1". | see version |
built required | The date of the source data this file was built from, as YYYY-MM-DD. | see date |
source required | The script and files this file was built from, as paths in the repository. | see source |
purpose required | One sentence on what this file is for. | see nonEmptyString |
appLaneNote required | A note on which choices this file leaves to the app code that reads it, such as fetching, layout and wording. | see nonEmptyString |
contracts required | One contract per kind of page: category, item, guide, brand, company, tag, errand and line. | list |
totals required | How many pages of each kind exist, by kind. | object |
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
Node page contracts define hash route patterns, required fields, sections, examples, and totals.
{
"format": "ovs-node-page-contracts",
"version": "0.1",
"built": "2026-07-07",
"source": [
"pipeline/build_nodes.js"
],
"purpose": "Route and page contract data for app-owned rendering.",
"appLaneNote": "Contract only.",
"contracts": [
{
"type": "category",
"routePattern": "#explore/<cid>",
"source": "app/data/index.json",
"requiredFields": [
"id",
"label"
],
"sections": [
"summary"
],
"examples": [
{
"id": "ovs:cat/banking",
"label": "Ethical banking",
"hash": "#explore/banking"
}
]
}
],
"totals": {
"categories": 1
}
}
A file that must be rejected
Page contract route patterns must be hash routes.
{
"format": "ovs-node-page-contracts",
"version": "0.1",
"built": "2026-07-07",
"source": [
"pipeline/build_nodes.js"
],
"purpose": "Route and page contract data.",
"appLaneNote": "Contract only.",
"contracts": [
{
"type": "category",
"routePattern": "explore/<cid>",
"source": "app/data/index.json",
"requiredFields": [
"id"
],
"sections": [
"summary"
],
"examples": [
{
"id": "ovs:cat/banking",
"label": "Ethical banking",
"hash": "#explore/banking"
}
]
}
],
"totals": {
"categories": 1
}
}
The schema
Its address is https://openvaluesstandard.org/schema/node-page-contracts-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/node-page-contracts.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.