◇ Open Values Standardfor builders

Spec / ovs-public-proposals

Open Values Public Proposals v0.1

The proposals readers have posted in public to change where a list sits, what it is called or what it measures, as read from the open repository's issues at release. Backing is the thumbs-up count on each issue. The app may connect only to its own site, so it reads this file instead of asking GitHub.

A file a build step makes from other files. Change the sources, not this file.

Who writes it and who reads it

Written by pipeline/fetch_public_proposals.js. Read by Proposals page (#proposals).

Fields

FieldWhat it meansType
format requiredNames this file's format.always "ovs-public-proposals"
version requiredFormat version.string
source requiredThe live list this file was read from.string
fetchedAt requiredThe day the list was read.string
note requiredWhat the file holds, in one sentence.string
counts requiredHow many proposals are open and how many are closed.object
proposals requiredOne row per posted proposal, open ones first, then by backing.list of object

This format allows no fields beyond the list above. A writer MUST NOT add any.

The schema

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