◇ Open Values Standardfor builders

Spec / open-values-register-coverage-matrix

Open Values Register Coverage Matrix

A generated table that gives every open or built decision a status against every register on the shelf: applicable, not applicable, blocked, or not yet reviewed. A build script makes it from the taxonomy, the shelf and the coverage rules, and it is used to plan register passes.

Draft. It may still change before it is called stable. 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/registers/build_coverage_matrix.py. Read by register pass planning, catalogue content coverage reporting.

Fields

FieldWhat it meansType
format requiredNames the file format. Always open-values-register-coverage-matrix.always "open-values-register-coverage-matrix"
version requiredThe version of this format the file follows. Always 1.0.0.always "1.0.0"
generatedFrom requiredThe four files the matrix was built from, each with the SHA-256 hash of its bytes, so a stale matrix can be detected.object
counts requiredTotals for the whole matrix: taxonomyDecisions, targetDecisions (covered plus open), coveredDecisions, openDecisions, builtTargetDecisions, excludedHoldDecisions, excludedOutDecisions, registers, relationships (target decisions times registers) and statuses (how many relationships have each status).object
registers requiredOne row per register on the shelf, sorted by id, with how many decisions fall under each status.list of object
decisions requiredOne row per covered or open taxonomy decision, sorted by id, with its status against every register.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-matrix-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-coverage-matrix.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.