Spec / open-values-register-entity-inventory
Open Values Register Entity Inventory
A list of every decision in the catalogue with how many options it has and a hash of their codes and names. A build script makes it from the dataset index, and the register mapping tools use it to notice when an option has been added, removed or renamed.
- Files built from other files
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-entity-inventory
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_entity_inventory.py. Read by register entity map scaffolder, register entity mapping audit.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-entity-inventory. | always "open-values-register-entity-inventory" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
generatedFrom required | The file this inventory was built from, with its hash, so a stale inventory can be detected. | object |
counts required | Totals across the whole inventory. | object |
catalogueIdentitySha256 required | One SHA-256 hash over every decision's cid, entityCount and identitySha256. It changes whenever any option is added, removed, renamed or recoded anywhere in the catalogue. | string |
decisions required | One row per built decision, sorted by cid. | 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-entity-inventory-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-entity-inventory.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.