Spec / ovs-ask-fixtures
Open Values Ask Fixtures v0.1
Test searches for Ask, the site's search box, each with the results it must find and the order they must come in. The data build writes them as tests for the app. 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-ask-fixtures
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 Ask 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-ask-fixtures" |
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 |
resolverOrder required | The match rules from strongest to weakest, with type as the final tiebreak. | list |
layers required | The two Ask indexes, "core" (loaded at startup) and "full" (loaded for product search), with their files. | list of object |
cases required | The test queries. | 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
Ask fixtures carry normalized golden queries and expected Open Values targets.
{
"format": "ovs-ask-fixtures",
"version": "0.1",
"built": "2026-07-07",
"source": "pipeline/build_nodes.js",
"purpose": "Golden resolver contract for app-owned Ask integration.",
"resolverOrder": [
"exact-alias",
"exact",
"query-token"
],
"layers": [
{
"layer": "core",
"file": "ask-core.json",
"use": "startup search"
}
],
"cases": [
{
"query": "best bank",
"intent": "category search",
"layer": "core",
"expectAny": [
"ovs:cat/banking"
],
"normalized": "best bank",
"expectOneInTop": 3
}
]
}
A file that must be rejected
Ask fixtures must name at least one expected target.
{
"format": "ovs-ask-fixtures",
"version": "0.1",
"built": "2026-07-07",
"source": "pipeline/build_nodes.js",
"purpose": "Golden resolver contract for app-owned Ask integration.",
"resolverOrder": [
"exact-alias"
],
"layers": [
{
"layer": "core",
"file": "ask-core.json",
"use": "startup search"
}
],
"cases": [
{
"query": "best bank",
"layer": "core",
"expectAny": [],
"normalized": "best bank"
}
]
}
The schema
Its address is https://openvaluesstandard.org/schema/ask-fixtures-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/ask-fixtures.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.