Skip to content

Branch main Contract Invariant

github-actions[bot] edited this page Jun 26, 2026 · 102 revisions

Contract: Invariant

Back to Branch Overview

Field Value
Branch main
Source specs/contracts/Invariant.schema.json
Commit 774b981ef226
Synced (UTC) 2026-06-26T05:47:13Z

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": "Invariant",
  "description": "ASH invariant reference.",
  "type": "object",
  "properties": {
    "invariantID": {
      "type": "string"
    },
    "conformanceCategory": {
      "type": "string"
    },
    "sourceReference": {
      "type": "string"
    },
    "diagnosticRule": {
      "$ref": "RuleReference.schema.json"
    }
  },
  "required": [
    "invariantID",
    "conformanceCategory",
    "sourceReference",
    "diagnosticRule"
  ],
  "additionalProperties": false
}

Clone this wiki locally