Spec / open-values-register-shelf
Open Values Register Shelf
The list of public registers, such as government recall and complaint databases, that this catalogue takes facts from, with how to fetch each one and the kinds of source it refuses. Maintainers edit it by hand, and the tools that capture, map and plan register passes read it.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-shelf
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 content planning, register passes.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-shelf. | always "open-values-register-shelf" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
note required | A short paragraph on what the shelf is for and how a register earns a place on it. | string |
howToRead required | Plain explanations of the four register fields a reader most needs: reach, access, provenanceKey and proven. | object |
registers required | The public registers admitted to the shelf, one entry each. | list |
refused required | Kinds of source the catalogue will not cite, each with the reason. | list |
This format allows no fields beyond the list above. A writer MUST NOT add any.
The schema
Its address is https://openvaluesstandard.org/schema/register-shelf-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-shelf.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.