Skip to main content

Module protocol

Module protocol 

Source
Expand description

Versioned public protocol surface (AGENTS-AI-FIRST-CLI.md §10/§12).

Every --json payload and every --output=jsonl event carries a schema_version. This module owns that contract and the public JSON/JSONL DTOs that ride on it. DTOs are versioned independently of the internal domain types (contract::schema, facts, audit, release) so ossctl-core can refactor internals without a wire break (ADR-0001 §2).

At founding this holds only the envelope schema version; the concrete DTOs (contract document, facts report, audit gap-report, release events) land with their owning units and each becomes a hot file under the migration rule (bump SCHEMA_VERSION on a breaking change, never silently).

Modules§

audit
Public wire DTO for the readiness gap-report (ossctl audit).
contract
Public wire DTO for the normalized OSS-RELEASE.md contract (SCHEMA.md §4).
facts
Public wire DTO for the deterministic repo-fact report (ossctl facts).
journal
Public wire DTOs for the event-sourced release journal (ADR-0003).
plan
Public wire DTO for the sealed, content-addressed release plan (ossctl release plan — ADR-0002 §3).
reconcile
Public wire DTO for ossctl release verify — the read-only reconcile report (ADR-0002 §1, ADR-0003 state table).
release
Public wire DTOs for the release engine’s per-target adapter facts (ADR-0002).

Constants§

SCHEMA_VERSION
Current envelope/DTO schema version for ossctl’s public JSON output.
SUPPORTED_SCHEMAS
The set of envelope schema versions this binary can emit and understand.