relations.json
What links between entities mean.
relations
array of objects
A link from entities of one type to entities of another, such as brand from product to brand.
The code of a relation definition, such as brand or compatible_with.
The code of an entity type, such as product, category or a merchant's own store.
The code of an entity type, such as product, category or a merchant's own store.
A plain value, or a map from locale to value such as { "de": "Farbe", "en": "Color" }.
Notes that belong to one link, such as "only with sport suspension". Shown and traced, never filtered silently.
A note a single link may carry.
A link to a target that does not exist creates it, as a feed's brand name creates its brand.
Spellings OrbSearch maps onto a target's id, such as "Robert Bosch GmbH": "bosch". They survive every feed.
Whether the target's title becomes searchable text of the source. Forty printer names may; a thousand vehicle names may not. Default: false.
$schema
string
The JSON Schema an editor checks this file against; kept as written.
Example
{
"$schema": "../../../contracts/schema/relations.json",
"relations": [
{
"code": "brand",
"from": "product",
"to": "brand",
"label": { "de": "Marke", "en": "Brand" },
"create_missing": true,
"search_target_title": true
}
]
}Guide: The release files