Skip to content

Branch main Contract CanonicalCodewordSet

github-actions[bot] edited this page Jun 5, 2026 · 75 revisions

Contract: Canonicalcodewordset

Back to Branch Overview

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

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": "CanonicalCodewordSet",
  "description": "Fixed 16-codeword canonical ASH set.",
  "type": "object",
  "properties": {
    "codewordSetID": {
      "type": "string"
    },
    "codewords": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "integer",
          "enum": [
            0,
            1
          ]
        },
        "minItems": 9,
        "maxItems": 9
      },
      "minItems": 16,
      "maxItems": 16
    },
    "sourceReference": {
      "type": "string"
    },
    "canonicalHash": {
      "type": "string"
    }
  },
  "required": [
    "codewordSetID",
    "codewords",
    "sourceReference",
    "canonicalHash"
  ],
  "additionalProperties": false
}

Clone this wiki locally