Coverage summary schema

The field contract of the coverage summary object, read from coverage_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/coverage_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, coverage, readiness

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 "coverage_summary"
bundle_id	string	yes	minLength 1
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.
coverage_status	string or null	no
required_document_classes	array or null	no
recommended_document_classes	array or null	no
present_document_classes	array or null	no
missing_required_document_classes	array or null	no
missing_recommended_document_classes	array or null	no
stale_document_classes	array or null	no
conflicting_document_classes	array or null	no
stale_documents	array or null	no
conflicting_source_groups	array or null	no
coverage	object	yes
coverage.required_present	integer	yes	minimum 0
coverage.required_total	integer	yes	minimum 0
coverage.required_pct	number	no	minimum 0
coverage.recommended_present	integer	no	minimum 0
coverage.recommended_total	integer	no	minimum 0
coverage.recommended_pct	number	no	minimum 0
readiness	object	yes
readiness.status	string or null	yes
readiness.publish_ready	boolean or null	no
readiness.verify_ready	boolean or null	no
readiness.blocking_reasons	array or null	no
readiness.warnings_detail	array or null	no
readiness.blockers	array or null	no
readiness.warnings	array or null	no
class_posture	array or null	no
schema_version	string	yes	enum: v2
document_classes	array of object	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.