Spec / open-values-register-coverage-rules
Open Values Register Coverage Rules
Hand-reviewed rules saying which catalogue decisions each public register can supply facts for. Maintainers write them, and the coverage matrix builder applies them; any pair no rule covers stays marked as not yet reviewed.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-coverage-rules
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
Written by pipeline/registers/build_coverage_matrix.py. Read by register pass planning, coverage reporting.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-coverage-rules. | always "open-values-register-coverage-rules" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
updated required | The date the rules were last changed, as YYYY-MM-DD. | string |
note required | A short paragraph on what the rules do and how a missing rule is read. | string |
statusDefinitions required | The meaning of each coverage status, in a sentence each. | object |
registers required | One rule set per register on the shelf. Every shelf register must have exactly one, and no others are allowed. | 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-coverage-rules-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-coverage-rules.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.