Spec / ovs-node-walkthroughs
Open Values Node Walkthroughs v0.1
Worked examples that follow one search, such as "is nestle bad", through to the company, brand and line pages it should open, with the checks each must pass. The data build writes them for testing the app by hand. 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-walkthroughs
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 preview QA, 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-walkthroughs" |
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 |
walkthroughs required | The walkthroughs. Each follows one Ask query through to the pages it should open. | 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
Node walkthroughs carry Ask hits, expected graph targets, page fixtures, and green checks.
{
"format": "ovs-node-walkthroughs",
"version": "0.1",
"built": "2026-07-07",
"source": [
"app/data/nodes/ask-core.json"
],
"purpose": "Generated walkthrough contracts for app-owned QA.",
"appLaneNote": "Use as dev-contract test data.",
"walkthroughs": [
{
"id": "sample-path",
"label": "Sample path",
"query": "best bank",
"expected": {
"company": "ovs:company/sample",
"line": "ovs:line/avoid:sample",
"brands": [
"ovs:brand/sample"
]
},
"askTop": [
{
"id": "ovs:brand/sample",
"label": "Sample",
"hash": "#n/brand/sample",
"score": 100,
"reason": "exact"
}
],
"matchedTop": "ovs:brand/sample",
"pages": {
"company": {
"hash": "#n/company/sample"
}
},
"checks": {
"askResolved": true
}
}
]
}
A file that must be rejected
Walkthrough contracts should not ship failed checks as passing fixtures.
{
"format": "ovs-node-walkthroughs",
"version": "0.1",
"built": "2026-07-07",
"source": [
"app/data/nodes/ask-core.json"
],
"purpose": "Generated walkthrough contracts for app-owned QA.",
"appLaneNote": "Use as dev-contract test data.",
"walkthroughs": [
{
"id": "sample-path",
"label": "Sample path",
"query": "best bank",
"expected": {
"company": "ovs:company/sample",
"line": "ovs:line/avoid:sample",
"brands": [
"ovs:brand/sample"
]
},
"askTop": [
{
"id": "ovs:brand/sample",
"label": "Sample",
"hash": "#n/brand/sample",
"score": 100,
"reason": "exact"
}
],
"matchedTop": "ovs:brand/sample",
"pages": {
"company": {}
},
"checks": {
"askResolved": false
}
}
]
}
The schema
Its address is https://openvaluesstandard.org/schema/node-walkthroughs-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/node-walkthroughs.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.