Spec / open-values-collective
Open Values Collective v0.1
A group's values, worked out in the browser by averaging several people's values files. It records how far apart the group is on each value and includes a values file for the group that any app can read. The Assembly page at /assembly/ makes it.
- Files people or tools write
- Status: draft
- Version: 0.1
- Format name in the file:
open-values-collective
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
No writer is listed. Read by assembly/index.html, app/engine.js mergePassports.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Always "open-values-collective". Tells a reader that this file is a group's values, added up. | always "open-values-collective" |
version required | The version of the collective format this file follows, 0.1. | string |
name | What the group called itself, or 'an assembly'. | string |
n required | How many values files were added up. The file cannot tell how many people are behind them. | integer |
members | A label for each file, as its owner gave it. Not a name unless someone typed one. | list of string |
values required | The group's mean weight, 0 to 5, for each shared value at least one file gave. A value no file gave is left out, not set to 0. | map of number |
agreement required | For each value in values: the mean, the spread, a consensus from 0 (split) to 1 (all the same), and how many files gave it. | map of object |
dissent required | The values in agreement, most split first. | list of string |
passport required | A values file for the group, with the group's average weights and its name as the source, so any app that reads values files can use it. | a passport-v0.1 file |
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/collective-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/collective.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.