Spec / ovs-non-brand-values
Open Values Non-Brand Values v1
A list of words found in the brand field of options that are not brands, such as "generic" or "private messenger". The site's build uses it so it does not treat them as companies. Conscious Consuming keeps it.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
ovs-non-brand-values
Draft. It may still change before it is called stable. A file someone writes by hand or with a tool, and keeps.
Who writes it and who reads it
Written by pipeline/build_nodes.js, pipeline/build_cards.js. Read by brand node index, verdict card JSON-LD.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "ovs-non-brand-values". Tells a reader that this file lists brand-field text that is not a brand. | always "ovs-non-brand-values" |
version required | The version of this file's format, as major.minor.patch starting with 1. | string |
updated required | The day the file was last changed, as YYYY-MM-DD. | string |
groups required | The values, sorted into named groups such as "placeholders" or "kinds of software and service". Each value is compared with an entry's brand text after both are lower-cased, with accents removed, "&" read as "and", apostrophes dropped and other punctuation read as a space. | map of list of string |
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.
The schema
Its address is https://openvaluesstandard.org/schema/non-brand-values-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/non-brand-values.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.