8000
Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Ethos Schemas — product contracts and repository records

JSON Schema draft 2020-12. $ids use urn:ethos:schema:<name>:<major> so schema identity survives any package rename (ADR-0006). Changes only via contract-change PRs with version bumps and downstream sign-off; output-changing heuristics are semver events (PRD §5.1).

External product contracts

These schemas govern artifacts or configuration that producers and consumers exchange. This is the consumer-facing schema surface; compatibility and versioning rules apply to it.

Schema Artifact it governs
ethos-document.schema.json ethos.json — canonical document graph (primary artifact)
ethos-chunks.schema.json chunks.jsonl — one self-describing RAG chunk per line
ethos-security-report.schema.json security_report.json
ethos-citations.schema.json citation input consumed by ethos verify --citations
ethos-llm-citation-output.schema.json independently versioned model/framework callback output hydrated into verifier citation input; see docs/citation-emission-spec.md
ethos-verification-report.schema.json verification_report.json
ethos-app-answer-release-decision.schema.json non-canonical app wrapper decision envelope for answer release policy over Ethos proof summaries
ethos-evidence-anchor-request.schema.json evidence refs consumed by ethos evidence anchor --evidence-refs
ethos-evidence-anchor-report.schema.json evidence_anchor_report.json emitted by ethos evidence anchor
ethos-verification-config.schema.json verification config (its c14n hash stamps reports)
ethos-crop-descriptor.schema.json crop descriptor JSON emitted by ethos crop_element and ethos verify --crop-dir
ethos-deterministic-profile.schema.json profiles/ethos-deterministic-v*.json checker

Internal process and guard schemas

These schemas validate source-tree contract inventories, milestone records, request fixtures, and release-governance data. They keep repository evidence deterministic, but they are not supported consumer exchange contracts and their presence does not approve a public surface. They remain here so the existing validation harness can check all repository JSON without moving paths.

Schema Repository record it governs
ethos-evidence-anchor-contract.schema.json evidence_anchor v1 source-only public beta evaluation guard inventory
ethos-crop-element-request.schema.json source-only request envelope for Milestone D crop_element v1 contract work
ethos-verify-citations-contract.schema.json Milestone D verify_citations v1 source-only contract inventory
ethos-claim-kind-boundary-contract.schema.json Milestone D claim_kind_boundary v1 source-only contract inventory
ethos-grounding-source-contract.schema.json Milestone D grounding_source v1 source-only contract inventory
ethos-capability-downgrade-contract.schema.json Milestone D capability_downgrade v1 source-only contract inventory
ethos-opendataloader-adapter-shape-contract.schema.json Milestone D opendataloader_adapter_shape v1 source-only contract inventory
ethos-crop-element-contract.schema.json Milestone D crop_element v1 source-only contract inventory
ethos-crop-element-surface-shape-contract.schema.json Milestone D crop_element_surface_shape v1 source-only contract inventory
ethos-sandbox-subprocess-request.schema.json source-only request envelope for Milestone D sandbox_subprocess v1 contract work
ethos-sandbox-subprocess-contract.schema.json Milestone D sandbox_subprocess v1 source-only contract inventory
ethos-milestone-e-fixture-candidates.schema.json Milestone E source-only internal fixture-candidate inventory
ethos-milestone-e-fixture-promotion-criteria.schema.json Milestone E source-only internal fixture-promotion criteria
ethos-milestone-e-internal-trust-loop-walkthrough.schema.json Milestone E source-only internal trust-loop walkthrough plan
ethos-milestone-e-internal-trust-loop-use-protocol.schema.json Milestone E source-only internal trust-loop use protocol
ethos-milestone-e-internal-trust-loop-rehearsal-evidence-matrix.schema.json Milestone E source-only internal trust-loop rehearsal/evidence matrix
ethos-milestone-e-internal-trust-loop-blocker-ledger.schema.json Milestone E source-only internal trust-loop blocker ledger
ethos-milestone-e-public-approval-lane-blockers.schema.json Milestone E source-only public approval lane blocker ledger
ethos-milestone-e-public-beta-approval-prep.schema.json Milestone E source-only public beta approval prep
ethos-milestone-e-package-publication-approval-prep.schema.json Milestone E source-only package publication approval prep
ethos-milestone-e-public-facing-readiness-ledger.schema.json Milestone E source-only public-facing readiness current-main ledger
ethos-milestone-e-public-beta-current-main-refresh-prep.schema.json Milestone E source-only public beta current-main refresh prep

Conventions: snake_case keys; additionalProperties: false everywhere except the runtime-only diagnostics envelope field; geometry is integer quanta (no floats anywhere in canonical values); confidences are integer per-mille; fingerprints are sha256:<64 lowercase hex>; ID grammar and ordering are normative in docs/determinism-contract.md §5.

examples/ validate in CI via validate_examples.py (also enforces referential integrity and bbox sanity that JSON Schema cannot express). The examples are documentation-grade — keep them small, valid, and mutually consistent (same fingerprints across document / chunks / security-report / verification-report examples).

verification-report.example.json shows a grounded report. verification-report-negative.example.json shows a non-grounded report with a per-check reason label.

App answer release guidance is tracked in docs/app-answer-release-contract.md. The schema ethos-app-answer-release-decision.schema.json and example schemas/examples/app-answer-release-decision.example.json describe a non-canonical wrapper decision envelope for apps that combine Ethos citation grounding with app-owned relevance and synthesis policy. This envelope is not verification_report.json, is not emitted by the verifier, and is not a replacement for the canonical audit report.

Evidence-anchor V1 guard work is tracked in docs/evidence-anchor-v1-contract.md. In this source-only public beta evaluation guard, evidence_anchor names the deterministic source-tracing contract currently carried by ethos evidence anchor; it does not add semantic answer verification, hosted/API behavior, app-specific integration, crop rendering, or production positioning. The contract inventory at examples/verify/evidence_anchor_v1_contract.json is schema-validated here; its alignment with focused CLI tests, OpenDataLoader adapter coverage, status docs, and Makefile wiring is checked by the evidence-anchor repository guard.

The v0.2.x compatibility policy is tracked in docs/v0-2-x-compatibility-policy.md. Verification report schemas, evidence-anchor request/report schemas, default verification-config semantics, GroundingSource obligations, and CLI JSON input/output shapes are frozen across compatible 0.2.x updates after the 0.2.0 lane is approved and published.

Milestone D verify_citations v1 contract work is tracked in docs/milestone-d-verify-citations-contract.md. In this source-only pre-alpha slice, verify_citations names the citation-input to verification-report contract currently carried by ethos verify; it does not add a new command or binding surface. The contract inventory at examples/verify/verify_citations_v1_contract.json is schema-validated here; its alignment with the executable case inventory and report goldens is checked by the Milestone D repository guard.

Milestone D claim_kind_boundary v1 contract work is tracked in docs/milestone-d-claim-kind-boundary-contract.md. In this source-only pre-alpha slice, claim_kind_boundary names the supported v1 claim-kind boundary currently carried by ethos verify; it does not add new claim-kind support or a new command/binding surface. The contract inventory at examples/verify/claim_kind_boundary_v1_contract.json is schema-validated here; its alignment with the committed non-v1 claim fixture and report golden is checked by the Milestone D repository guard.

Milestone D grounding_source v1 contract work is tracked in docs/milestone-d-grounding-source-contract.md. In this source-only pre-alpha slice, grounding_source names the parser-neutral evidence boundary currently carried by the GroundingSource trait and ethos verify report grounding metadata; it does not add a new command or binding surface. The contract inventory at examples/verify/grounding_source_v1_contract.json is schema-validated here; its alignment with trait methods, source implementations, focused verifier tests, and report goldens is checked by the Milestone D repository guard.

Milestone D capability_downgrade v1 contract work is tracked in docs/milestone-d-capability-downgrade-contract.md. In this source-only pre-alpha slice, capability_downgrade names the grounding-source capability declaration to verification-report downgrade contract currently carried by ethos verify; it does not add a new command or binding surface. The contract inventory at examples/verify/capability_downgrade_v1_contract.json is schema-validated here; its alignment with report goldens is checked by the Milestone D repository guard.

Milestone D opendataloader_adapter_shape v1 contract work is tracked in docs/milestone-d-opendataloader-adapter-shape-contract.md. In this source-only pre-alpha slice, opendataloader_adapter_shape names the adapter input-shape to GroundingSource contract currently carried by ethos-grounding-opendataloader-json and ethos verify --grounding opendataloader-json; it does not add a new command or binding surface. The contract inventory at examples/verify/opendataloader_adapter_shape_v1_contract.json is schema-validated here; its alignment with adapter tests, CLI grounding tests, report goldens, and usage diagnostics is checked by the Milestone D repository guard.

Milestone D crop_element v1 contract work is tracked in docs/milestone-d-crop-element-contract.md. In this source-only pre-alpha slice, crop_element names the element-to-crop-descriptor contract currently carried by the source-bound ethos crop_element CLI command. The existing ethos verify --crop-dir carrier continues to emit verifier evidence artifacts from the same descriptor type, with optional rendered artifacts when caller-provided source PDF bytes are bound. The request envelope example at schemas/examples/crop-element-request.example.json and contract inventory at examples/crop/crop_element_v1_contract.json are schema-validated here; their alignment with the document and crop-descriptor examples is checked by the Milestone D repository guard. The request envelope carries a c14n-derived request_ref identity guarded in that same source-only contract check.

Milestone D crop_element_surface_shape v1 contract work is tracked in docs/milestone-d-crop-element-surface-shape-contract.md. In this source-only pre-alpha slice, crop_element_surface_shape names the callable crop surface shape that must preserve the existing crop request and descriptor bindings. The contract inventory at examples/crop/crop_element_surface_shape_v1_contract.json is schema-validated here; its alignment with the request schema, descriptor schema, source-bound CLI command, and source-bound Python wrapper is checked by the Milestone D repository guard.

Milestone D sandbox_subprocess v1 contract work is tracked in docs/milestone-d-sandbox-subprocess-contract.md. In this source-only pre-alpha slice, sandbox_subprocess names the future worker-boundary contract currently represented by the existing PDF worker process behind ethos doc parse and ethos fingerprint; it does not add a hardened sandbox or a new command/binding surface. The request envelope examples under schemas/examples/sandbox-subprocess-*.example.json and the contract inventory at examples/sandbox/sandbox_subprocess_v1_contract.json are schema-validated here; their alignment with the executable worker tests is checked by the Milestone D repository guard. Each request envelope carries a c14n-derived request_ref identity guarded in that same source-only contract check.

Milestone E prep is tracked in docs/milestone-e-prep-scope.md. In this source-only pre-alpha slice, the fixture-candidate inventory at docs/milestone-e-fixture-candidates.json, fixture-promotion criteria at docs/milestone-e-fixture-promotion-criteria.json, internal trust-loop walkthrough plan at docs/milestone-e-internal-trust-loop-walkthrough.json, and internal trust-loop use protocol at docs/milestone-e-internal-trust-loop-use-protocol.json, and internal trust-loop rehearsal/evidence matrix at docs/milestone-e-internal-trust-loop-rehearsal-evidence-matrix.json, and internal trust-loop blocker ledger at docs/milestone-e-internal-trust-loop-blocker-ledger.json, and public approval lane blocker ledger at docs/milestone-e-public-approval-lane-blockers.json, public beta approval prep at docs/milestone-e-public-beta-approval-prep.json, and package publication approval prep at docs/milestone-e-package-publication-approval-prep.json, and public-facing readiness ledger at docs/milestone-e-public-facing-readiness-ledger.json, and public beta current-main refresh prep at docs/milestone-e-public-beta-current-main-refresh-prep.json are schema-validated here. Their path tracking, candidate-to-criteria-to-walkthrough alignment, diagnostic-boundary alignment, evidence-lane alignment, explicit blocker alignment, public approval lane blockers, public beta approval prep blockers, package publication approval prep blockers, current-main refresh candidate binding, package-publication gap retention, public beta current-main refresh prep boundaries, and public-posture boundaries are checked by the Milestone E prep repository guards.

Derived artifacts not schema'd here: document.md / document.txt (deterministic exports specified by the exporter config, Milestone B) and debug.html (Milestone C).

0