ByteOr Enterprise Artifact Schemas v1

These artifact formats are versioned operator contracts produced by the current byteor and byteor-enterprise runtime surface.

Compatibility contract

  • Every artifact below is versioned and should be treated as a machine-readable API.
  • Breaking changes require a version bump and coordinated reader/writer updates.
  • Additive fields are only acceptable when older readers can ignore them safely.
  • Tests should keep round-trip coverage for every serialized format listed here.

Incident bundle directory format v1

Producer: byteor-runtime::incident_bundle()

Required files:

  • spec.kv
  • spec_validation.json
  • runtime.json
  • policy_audit.json
  • environment.json

Conditional files:

  • runtime_config.txt
  • single_ring_snapshot.json
  • lane_graph_state.json

spec_validation.json

  • ok: bool
  • description: string when validation succeeds
  • error: string when validation fails

runtime.json

  • crate.name: string
  • crate.version: string

environment.json

  • pid: u32
  • cwd: string | null
  • args: string[]
  • env: [string, string][] sorted by key
  • proc_status: string | null

Replay audit JSON v1

Producer: byteor-replay

Root object:

  • audit_v: u32
  • created_unix_ms: u128
  • bundle_dir: string
  • spec_sha256: string
  • input: ReplayAuditInput
  • policy: ReplayAuditPolicy
  • actions: ReplayAuditAction[]

ReplayAuditInput

  • journal_lane: string
  • journal_path: string
  • last_n: u64
  • scanned_records: u64
  • selected_bytes: u64
  • sample_sha256: string[]

ReplayAuditPolicy

  • env: string
  • approval_provided: bool
  • mode: string with dry_run or execute

ReplayAuditAction

  • action: string
  • role: string
  • input_lane: string
  • output_lane: string
  • stage: string
  • target: string
  • decision: string

Policy audit record JSON v1

Producer: byteor-runtime::policy_audit_record_for_spec()

Root object:

  • ok: bool
  • policy_version: 1
  • mode: string
  • enforced: bool
  • stage_failure_policy: "stop_pipeline"
  • spec_path: string
  • lane_path: string | null
  • wait: string | null
  • runtime_crate.name: string
  • runtime_crate.version: string
  • spec: object when parsing succeeds
  • error: string when parsing fails

Parsed spec summary

  • model: string
  • SingleRing records include single_ring
  • LaneGraph records include lane_graph

SingleRing summaries include shard, ordering, producer, scheduling, shard key, and stage counts.

LaneGraph summaries include on_full, plus lane, role, endpoint, lane-kind, and role-kind summaries.

DataGuard report KV v1

Producer: byteor-dataguard-core::DataGuardAudit::report_kv_v1()

Encoding rules:

  • UTF-8 text
  • one key=value pair per line
  • newline-delimited
  • stable key prefixes such as report., schema., policy., counts., and cost.

Required keys include:

  • report.v=1
  • report.kind=dataguard
  • schema.registry_root=<path>
  • expected.codec_id=<u16>
  • counter keys under counts.*

Conditional keys include schema selection, redaction mode and rule summary, and cost attribution fields when enabled.

Compile report JSON v1

Producer type: byteor-pipeline-ir::CompileReportV1

Root object:

  • spec: PipelineSpecV1
  • diagnostics: CompileDiagnosticV1[]

Compile diagnostics are currently centered on inserted bridges, routers, and merges.

Validation coverage

Round-trip or artifact-shape coverage should remain in place for:

  • incident bundle file sets and JSON payloads
  • replay audit JSON
  • policy audit JSON
  • DataGuard report KV rendering and parsing
  • compile report JSON
Provenance
Need the canonical source?
Use the public hub to orient yourself, then jump to repo-owned docs or rustdoc when you need contract-level detail.