◇ Open Values Standardfor builders

Spec / open-values-passport

Open Values Passport v0.1

A small file that says how much each of ten shared values matters to one person, from 0 to 5, with no name in it. The person keeps it and can carry it to any app that reads the format.

Stable. A change that breaks existing files needs a new version. 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 app/engine.js, values export/import, federation tests.

Fields

FieldWhat it meansType
format requiredAlways "open-values-passport". Tells a reader that this file is a values file.always "open-values-passport"
version requiredThe version of the passport format this file follows, 0.1. Readers of 0.1 ignore fields they do not know.string
sourceWhich app wrote the file, such as "conscious-consuming", or the group's name when the file was made by adding up several people's files. Not a person's name.string
exportedWhen the file was downloaded, as an ISO 8601 date and time. Conscious Consuming sets it; other apps may leave it out.string
values requiredHow much the person cares about each shared value, from 0 (ignore it) to 5 (matters most). 3 is neutral. A value that is missing was not set, which is not the same as 0.object

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 passport carries universal value weights from 0 to 5.

{
  "format": "open-values-passport",
  "version": "0.1",
  "source": "conformance-fixture",
  "values": {
    "planet": 5,
    "openness": 4,
    "access": 3
  }
}

A file that must be rejected

Passport values must use the universal vocabulary.

{
  "format": "open-values-passport",
  "version": "0.1",
  "values": {
    "planet": 5,
    "made_up": 4
  }
}

The schema

Its address is https://openvaluesstandard.org/schema/passport-v0.1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/passport.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.