Spec / open-values-register-evidence-review
Open Values Register Evidence Review
The record of a person checking the sample of entries in one evidence bundle against the register and the option mappings, and approving or rejecting it. Reviewers write it by hand, and only an approved receipt whose bundle has not changed lets the evidence into the catalogue.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-evidence-review
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 future lens promotion gate, register pass reviewers.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-evidence-review. | always "open-values-register-evidence-review" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
registerId required | The id of the register the reviewed evidence comes from. | string |
snapshotId required | The id of the snapshot the reviewed evidence was built from. | string |
evidence required | Path of the evidence bundle this receipt reviews, under pipeline/registers/evidence/. Each bundle has at most one receipt. | string |
evidenceSha256 required | The SHA-256 hash of the bundle file as reviewed. If the bundle changes, the hash no longer matches and the receipt stops counting. | string |
status required | approved means the sample checked out and the bundle may be promoted into lenses. rejected means it did not. | one of "approved", "rejected" |
reviewedBy required | Who did the review: a person's name or the name of the review pass. | string |
reviewedOn required | The date of the review, as YYYY-MM-DD. | string |
samples required | One row per entry in the bundle's review sample. The entry ids must be exactly the ones the bundle names in reviewRequirement. | 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/register-evidence-review-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-evidence-review.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.