Skip to content

Branch main Contract CodewordTransformation

github-actions[bot] edited this page Jun 10, 2026 · 76 revisions

Contract: Codewordtransformation

Back to Branch Overview

Field Value
Branch main
Source specs/contracts/CodewordTransformation.schema.json
Commit 5b2aac39fcf8
Synced (UTC) 2026-06-10T05:50:08Z

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": "CodewordTransformation",
  "description": "XOR-by-codeword transition.",
  "type": "object",
  "properties": {
    "transformationID": {
      "type": "string"
    },
    "inputState": {
      "$ref": "AshState.schema.json"
    },
    "codeword": {
      "type": "array",
      "items": {
        "type": "integer",
        "enum": [
          0,
          1
        ]
      },
      "minItems": 9,
      "maxItems": 9
    },
    "outputState": {
      "$ref": "AshState.schema.json"
    },
    "diagnosticReference": {
      "$ref": "DiagnosticReference.schema.json"
    }
  },
  "required": [
    "transformationID",
    "inputState",
    "codeword",
    "outputState",
    "diagnosticReference"
  ],
  "additionalProperties": false
}

Clone this wiki locally