Change summary schema

The field contract of the change summary object, read from change_summary.schema.json. The schema file is the normative artifact; this page is a reading of it. Raw schema file at the release tag.

Property of the schema	Value
Schema identity ($id)	https://schemas.loquitur.dev/v1/change_summary.schema.json
JSON Schema dialect	https://json-schema.org/draft/2020-12/schema
Root type	object
Additional properties at the root	refused
Required at the root	object_type, schema_version, bundle_id, current_bundle_id

Fields

Field paths are dotted; [] marks the members of an array item. “Required” is stated against the object that holds the field.

Field	Type	Required	Constraints	Description
object_type	string	yes	const "change_summary"
schema_version	string	yes	enum: v2
bundle_id	string	yes	minLength 1
asset_id	string or null	no
asset_type	string or null	no	pattern ^[a-z0-9][a-z0-9_]{0,63}$	An asset type: an identifier, a value of the registered vocabulary asset_type (verification-vocabularies.md section 5), or null.
current_bundle_id	string	yes	minLength 1
previous_bundle_id	string or null	no
snapshot_seq_current	integer or null	no	minimum 1
snapshot_seq_previous	integer or null	no	minimum 1
supersedes_bundle_id	string or null	no
mark_changed	boolean or null	no
mark_delta_k	number or null	no
mark_delta_pct	number or null	no
verdict_changed	boolean or null	no
verdict_previous	string or null	no	enum: PASS, WARN, REVIEW, FAIL, null	Registry verdict, closed to the same four values as registry_entry.verdict. A free string here would let an arbitrary word or a lowercase status spelling validate on the pair a reader uses to see whether the verdict moved.
verdict_current	string or null	no	enum: PASS, WARN, REVIEW, FAIL, null	Registry verdict, closed to the same four values as registry_entry.verdict. See verdict_previous.
evidence_added	array of string	no
evidence_removed	array of string	no
evidence_count_delta	integer or null	no
claims_coverage_delta	object or null	no
freshness_changes	object or null	no
fields_changed	array or null	no
material_change	boolean or null	no
materiality_basis	object or null	no
materiality_threshold	object or null	no

Example

The schema carries one example instance under its root keyword example, an annotation that decides nothing about any instance. Read it in the raw schema file.