◇ Open Values Standardfor builders

Spec / ovs-node-route-guardrails

Open Values Node Route Guardrails v0.1

Page addresses that are broken, unsupported, point at nothing, or should be rewritten, with what the site must do for each. The data build writes them as tests for the app. It is an internal file used while building the site.

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, route QA.

Fields

FieldWhat it meansType
format requiredNames this file's format, so a reader can check it before reading the rest of the file.always "ovs-node-route-guardrails"
version requiredThe version of the format this file follows, such as "0.1".see version
built requiredThe date of the source data this file was built from, as YYYY-MM-DD.see date
source requiredThe script and files this file was built from, as paths in the repository.see source
purpose requiredOne sentence on what this file is for.see nonEmptyString
appLaneNote requiredA note on which choices this file leaves to the app code that reads it, such as fetching, layout and wording.see nonEmptyString
fallbackGuidance requiredWhat the app should do for each kind of case, by kind.object
cases requiredRoutes that are broken, unsupported, point at nothing, or should be rewritten, each with what the parser must report.list
totals requiredHow many cases there are, overall and 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

Route guardrails encode malformed, missing, unsupported, and canonicalization expectations.

{
  "format": "ovs-node-route-guardrails",
  "version": "0.1",
  "built": "2026-07-07",
  "source": [
    "app/data/nodes/node-route-fixtures.json"
  ],
  "purpose": "Negative and canonicalization route guardrails.",
  "appLaneNote": "Guardrail data only.",
  "fallbackGuidance": {
    "malformed": "Do not load a content page."
  },
  "cases": [
    {
      "id": "canonical-line",
      "kind": "canonicalize",
      "hash": "#n/line/avoid:nestle",
      "reason": "Line colons should be encoded.",
      "expect": {
        "parseable": true,
        "targetExists": true,
        "canonicalHash": "#n/line/avoid%3Anestle"
      }
    }
  ],
  "totals": {
    "cases": 1
  }
}

A file that must be rejected

Canonicalization guardrails must name the canonical hash route.

{
  "format": "ovs-node-route-guardrails",
  "version": "0.1",
  "built": "2026-07-07",
  "source": [
    "app/data/nodes/node-route-fixtures.json"
  ],
  "purpose": "Negative and canonicalization route guardrails.",
  "appLaneNote": "Guardrail data only.",
  "fallbackGuidance": {
    "malformed": "Do not load a content page."
  },
  "cases": [
    {
      "id": "canonical-line",
      "kind": "canonicalize",
      "hash": "#n/line/avoid:nestle",
      "reason": "Line colons should be encoded.",
      "expect": {
        "parseable": true,
        "targetExists": true,
        "canonicalHash": "n/line/avoid%3Anestle"
      }
    }
  ],
  "totals": {
    "cases": 1
  }
}

The schema

Its address is https://openvaluesstandard.org/schema/node-route-guardrails-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/node-route-guardrails.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.