Spec / ovs-node-manifest
Open Values Node Manifest v0.1
A table of contents for the generated files in app/data/nodes: each file's name, size, hash and when to load it. The data build writes it, and the app reads it first to know what to fetch. It is an internal file used while building the site.
- Files built from other files
- Status: stable
- Version: 0.1
- Format name in the file:
ovs-node-manifest
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_nodes.js. Read by future node loader, app-lane integration.
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-manifest" |
version required | The version of the format this file follows, such as "0.1". | string |
built required | The date of the source data this file was built from, as YYYY-MM-DD. | string |
source required | The script that wrote this file. | string |
appLaneNote required | A note on which choices this file leaves to the app code that reads it, such as fetching, layout and wording. | string |
integrity required | How the hashes in this file are computed. | object |
loadOrder required | The generated file names in the order the app should load them. | list of string |
indexes required | One record per generated file in app/data/nodes, with its size, hash and load hint. | list |
loaderPlan required | The load stages from node-load-plan.json, with each file's size, hash and cache key filled in. | see loaderPlan |
totals required | Counts across the generated files, by name, such as "askTokens" or "nodeRouteFixtures". | map of integer |
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 node manifest records load order and integrity metadata for generated node files.
{
"format": "ovs-node-manifest",
"version": "0.1",
"built": "2026-07-07",
"source": "pipeline/build_nodes.js",
"appLaneNote": "App-owned code decides how to load these files.",
"integrity": {
"algorithm": "sha256",
"scope": "Each index entry hashes the generated JSON body."
},
"loadOrder": [
"sample.json"
],
"loaderPlan": {
"purpose": "App-readable runtime fetch plan derived from node-load-plan.json and manifest hashes.",
"source": "app/data/nodes/node-load-plan.json",
"integrity": {
"algorithm": "sha256",
"cacheKey": "<file>:<sha256>",
"validate": "Validate generated files with manifest sha256 values.",
"retry": "Refetch once on parse or hash failure.",
"fallback": "Never fabricate generated node results."
},
"stages": [
{
"step": 1,
"id": "bootstrap-metadata",
"label": "Bootstrap metadata",
"loadHint": "eager-metadata",
"runtime": true,
"trigger": "App startup.",
"failureMode": "Keep existing app paths usable.",
"files": [
{
"file": "manifest.json",
"type": "manifest",
"loadHint": "eager-metadata",
"integrity": "self-unhashed",
"cacheKey": null
},
{
"file": "sample.json",
"type": "sample",
"loadHint": "eager",
"bytes": 100,
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"cacheKey": "sample.json:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
}
],
"totals": {
"stages": 1,
"runtimeStages": 1,
"devContractStages": 0
}
},
"indexes": [
{
"type": "sample",
"file": "sample.json",
"format": "ovs-node-index",
"version": "0.1",
"built": "2026-07-07",
"bytes": 100,
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"loadHint": "eager"
}
],
"totals": {
"generatedPageNodes": 1
}
}
A file that must be rejected
Manifest entries must carry sha256 digests.
{
"format": "ovs-node-manifest",
"version": "0.1",
"built": "2026-07-07",
"source": "pipeline/build_nodes.js",
"appLaneNote": "App-owned code decides how to load these files.",
"integrity": {
"algorithm": "sha256",
"scope": "Each index entry hashes the generated JSON body."
},
"loadOrder": [
"sample.json"
],
"loaderPlan": {
"purpose": "App-readable runtime fetch plan derived from node-load-plan.json and manifest hashes.",
"source": "app/data/nodes/node-load-plan.json",
"integrity": {
"algorithm": "sha256",
"cacheKey": "<file>:<sha256>",
"validate": "Validate generated files with manifest sha256 values.",
"retry": "Refetch once on parse or hash failure.",
"fallback": "Never fabricate generated node results."
},
"stages": [
{
"step": 1,
"id": "bootstrap-metadata",
"label": "Bootstrap metadata",
"loadHint": "eager-metadata",
"runtime": true,
"trigger": "App startup.",
"failureMode": "Keep existing app paths usable.",
"files": [
{
"file": "manifest.json",
"type": "manifest",
"loadHint": "eager-metadata",
"integrity": "self-unhashed",
"cacheKey": null
},
{
"file": "sample.json",
"type": "sample",
"loadHint": "eager",
"bytes": 100,
"sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"cacheKey": "sample.json:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
}
],
"totals": {
"stages": 1,
"runtimeStages": 1,
"devContractStages": 0
}
},
"indexes": [
{
"type": "sample",
"file": "sample.json",
"format": "ovs-node-index",
"version": "0.1",
"built": "2026-07-07",
"bytes": 100,
"sha256": "not-a-sha",
"loadHint": "eager"
}
],
"totals": {
"generatedPageNodes": 1
}
}
The schema
Its address is https://openvaluesstandard.org/schema/node-manifest-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/node-manifest.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.