package-report

Reference page for the package-report.schema.json JSON schema.

Versions

Accepted format: law.package-report/0.1.

Top-level fields

name	type-or-$ref	required	description
format	"law.package-report/0.1"	yes	—
kind	enum (5)	yes	—
subject	object	yes	—
outcome	enum (5)	yes	—
recordedAt	string	yes	—
producer	object	yes	—
configuration	object	yes	—
data	object	yes	—

Enumerations

location	values
properties/format	"law.package-report/0.1"
properties/kind	"quality", "compatibility", "benchmark", "inventory", "formalization"
properties/outcome	"passed", "failed", "unsupported", "not_run", "skipped"
allOf/0/if/properties/kind	"benchmark"
allOf/0/if/properties/outcome	"passed"
allOf/0/then/properties/data/properties/format	"law.package-benchmark/0.1"
allOf/0/then/properties/data/properties/adapter	"native-ffi"
allOf/0/then/properties/data/properties/scenarios/items/properties/outcome	"passed"
allOf/0/then/properties/data/properties/scenarios/items/properties/failedEvaluations	0
allOf/1/if/properties/kind	"formalization"
allOf/1/if/properties/outcome	"passed"
$defs/FormalizationMeasure/properties/format	"law.formalization-measure/0.1"
$defs/FormalizationMeasure/properties/levelsComputed/items	"SOURCE_ONLY", "ANCHORED", "EXECUTABLE"
$defs/FormalizationMeasure/properties/levelsNotComputed/items	"STRUCTURED", "SEMANTIC", "VERIFIED"
$defs/FormalizationMeasure/properties/freshness/properties/status	"verified", "unverified"
$defs/FormalizationMeasure/properties/freshness/properties/origin	"sources", "file", "none"
$defs/FormalizationDocument/properties/status	"measured", "undefined"
$defs/FormalizationDocument/properties/unit/properties/path	"declared", "recognized", "unsupported", "none"
$defs/FormalizationDocument/properties/problems/items/properties/code	"SOURCE_ONLY_UNEXPLAINED", "SCOPE_UNIT_MISSING", "DECLARED_UNIT_MISSING"
$defs/FormalizationDocument/properties/units/items/properties/level	"EXECUTABLE", "ANCHORED", "SOURCE_ONLY", "NONE"

Raw schema

https://law.arxo.io/schema/package-report.schema.json

FormalizationMeasure

Formalization measure document: levels over pinned publication units, aggregated units, text coverage, freshness. Shares are integer numerator/denominator pairs; floats are forbidden by the canon. Byte coverage is reported by the measure-mode run of the command line.

Type: object. Required: format, spec, algorithm, profile, package, levelsComputed, levelsNotComputed, freshness, documents, documentsWithoutText.

name	type-or-$ref	description
format	"law.formalization-measure/0.1"	—
spec	string	—
algorithm	string	—
profile	object	—
package	object	—
levelsComputed	array	—
levelsNotComputed	array	—
freshness	object	—
documents	array	—
documentsWithoutText	array	—

FormalizationDocument

Type: object. Required: publication, edition, documentHash, status, unit, textCoverage, foreignFragments.

name	type-or-$ref	description
publication	string	—
edition	string	—
documentHash	string	—
status	enum (2)	—
reason	string	—
unit	object	—
textCoverage	object	—
foreignFragments	integer	—
totals	object	—
levels	object	—
readingOnlyUnits	integer	—
aggregated	array	—
excluded	array	—
declaredOutOfScope	integer	—
unresolvedAnchors	integer	—
problems	array	—
units	array	—