Spec / open-values-rating
Open Values Rating v0.1
One option's score on one criterion, from 0 to 100. It is written either as a bare number, or null for unknown, or as a small record that also carries the criterion's key and the score's source.
- Parts of other formats
- Status: stable
- Version: 0.1.0
- Format name in the file:
open-values-rating
Stable. A change that breaks existing files needs a new version. Not a file on its own: a shape used inside other formats.
Who writes it and who reads it
No writer is listed. Read by open-values-entity, open-values-lens.
Fields
This schema lists no named fields; see the schema file for its shape.
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
A sparse score value can be a 0-100 number.
82
Null is an explicit unknown placeholder.
null
A file that must be rejected
Scores must stay within 0-100.
120
The schema
Its address is https://openvaluesstandard.org/schema/rating-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/rating.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.