Skip to content

Branch main Contract RecoveryStep

github-actions[bot] edited this page Jul 13, 2026 · 75 revisions

Contract: Recoverystep

Back to Branch Overview

Field Value
Branch main
Source specs/contracts/RecoveryStep.schema.json
Commit 774b981ef226
Synced (UTC) 2026-07-13T05:33:10Z

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": "RecoveryStep",
  "description": "Single platform-neutral recovery step.",
  "type": "object",
  "properties": {
    "stepID": {
      "type": "string"
    },
    "stepType": {
      "type": "string",
      "enum": [
        "NORMALIZE_STATE",
        "APPLY_CORRECTION",
        "SELECT_FALLBACK",
        "ENTER_CONTAINMENT",
        "ENTER_SAFE_HALT",
        "ROLLBACK",
        "VERIFY",
        "ESCALATE"
      ]
    },
    "description": {
      "type": "string"
    },
    "jsonMutationOperations": {
      "type": "array",
      "items": {
        "$ref": "JsonMutationOperation.schema.json"
      },
      "minItems": 0
    },
    "diagnosticReference": {
      "$ref": "DiagnosticReference.schema.json"
    }
  },
  "required": [
    "stepID",
    "stepType",
    "description",
    "jsonMutationOperations",
    "diagnosticReference"
  ],
  "additionalProperties": false
}

Clone this wiki locally