Branch main Contract DiagnosticEnvelope

Contract: Diagnosticenvelope

Back to Branch Overview

Field	Value
Branch	main
Source	specs/contracts/DiagnosticEnvelope.schema.json
Commit	774b981ef226
Synced (UTC)	2026-07-14T05:14:42Z

Visual Context

Contract pages define the machine-checkable object shape that crosses a lifecycle boundary.

flowchart LR
  Producer["Lifecycle producer"] --> Contract["Contract schema"]
  Contract --> Example["Schema example"]
  Example --> Validator["Schema validator"]
  Contract --> Fixture["Conformance fixture output"]
  Fixture --> Gate["Base-design gate"]

Loading

Reading Checklist

Question	Where to look
Which lifecycle boundary uses it?	Read description, required fields, and linked references.
What diagnostics are mandatory?	Inspect diagnostic reference fields and rule-reference links.
How is it validated?	Compare this schema with fixtures/schema_examples/ and conformance vectors.

---

JSON Payload

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DiagnosticEnvelope",
  "description": "Canonical diagnostic envelope used across lifecycle decisions.",
  "type": "object",
  "properties": {
    "diagnosticID": {
      "type": "string"
    },
    "chainRootReference": {
      "type": "string"
    },
    "parentDiagnosticID": {
      "type": [
        "string",
        "null"
      ]
    },
    "diagnosticKind": {
      "type": "string",
      "enum": [
        "STATE_VALIDITY",
        "RECOVERY",
        "POLICY",
        "BACKUP",
        "EXECUTION",
        "VERIFICATION",
        "ROLLBACK",
        "FALLBACK",
        "CONTAINMENT",
        "SAFE_HALT",
        "AUDIT",
        "MAPPING",
        "JSON_SEMANTICS"
      ]
    },
    "severity": {
      "type": "string",
      "enum": [
        "INFO",
        "WARNING",
        "ERROR",
        "CRITICAL"
      ]
    },
    "message": {
      "type": "string"
    },
    "ruleReferences": {
      "type": "array",
      "items": {
        "$ref": "RuleReference.schema.json"
      },
      "minItems": 1
    },
    "sourceReferences": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "evidence": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "required": [
    "diagnosticID",
    "chainRootReference",
    "parentDiagnosticID",
    "diagnosticKind",
    "severity",
    "message",
    "ruleReferences",
    "sourceReferences",
    "evidence"
  ],
  "additionalProperties": false
}