wireforge 0.1.0__py3-none-any.whl

wireforge/_data/schema/project.schema.json

@@ -0,0 +1,1240 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "WireForge project (root file, schema_version 1)",
+  "type": "object",
+  "required": [
+    "schema_version",
+    "project"
+  ],
+  "properties": {
+    "schema_version": {
+      "$ref": "#/$defs/schemaVersion"
+    },
+    "project": {
+      "$ref": "#/$defs/identifier"
+    },
+    "version": {
+      "$ref": "#/$defs/semver",
+      "description": "Version of this project/ICD set."
+    },
+    "description": {
+      "type": "string"
+    },
+    "namespace": {
+      "type": "string",
+      "pattern": "^[A-Za-z_][A-Za-z0-9_]*(::[A-Za-z_][A-Za-z0-9_]*)*$",
+      "description": "C++ namespace of the generated code."
+    },
+    "include": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "description": "Glob patterns (relative to this file) of fragment files merged into the project."
+    },
+    "defaults": {
+      "$ref": "#/$defs/defaults"
+    },
+    "defines": {
+      "$ref": "#/$defs/sections/properties/defines"
+    },
+    "profiles": {
+      "$ref": "#/$defs/sections/properties/profiles"
+    },
+    "checksums": {
+      "$ref": "#/$defs/sections/properties/checksums"
+    },
+    "enums": {
+      "$ref": "#/$defs/sections/properties/enums"
+    },
+    "types": {
+      "$ref": "#/$defs/sections/properties/types"
+    },
+    "user_types": {
+      "$ref": "#/$defs/sections/properties/user_types"
+    },
+    "messages": {
+      "$ref": "#/$defs/sections/properties/messages"
+    },
+    "interfaces": {
+      "$ref": "#/$defs/sections/properties/interfaces"
+    },
+    "schema_minor": {
+      "$ref": "#/$defs/schemaMinor"
+    },
+    "generator": {
+      "$ref": "#/$defs/generator"
+    },
+    "user_includes": {
+      "$ref": "#/$defs/userIncludes"
+    },
+    "bundle": {
+      "$ref": "#/$defs/bundleInfo"
+    },
+    "requirements": {
+      "$ref": "#/$defs/sections/properties/requirements"
+    },
+    "vectors": {
+      "$ref": "#/$defs/sections/properties/vectors"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "identifier": {
+      "type": "string",
+      "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
+    },
+    "semver": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+    },
+    "expression": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Expression in the WireForge expression language (docs/SCHEMA_SPEC.md section 7)."
+    },
+    "intOrExpr": {
+      "anyOf": [
+        {
+          "type": "integer"
+        },
+        {
+          "$ref": "#/$defs/expression"
+        }
+      ]
+    },
+    "numOrExpr": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "$ref": "#/$defs/expression"
+        }
+      ]
+    },
+    "scalarValue": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "endian": {
+      "enum": [
+        "big",
+        "little"
+      ]
+    },
+    "bitOrder": {
+      "enum": [
+        "msb_first",
+        "lsb_first"
+      ]
+    },
+    "rangeCheck": {
+      "type": "object",
+      "properties": {
+        "encode": {
+          "type": "boolean"
+        },
+        "decode": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "defaults": {
+      "type": "object",
+      "properties": {
+        "endian": {
+          "$ref": "#/$defs/endian"
+        },
+        "bit_order": {
+          "$ref": "#/$defs/bitOrder"
+        },
+        "range_check": {
+          "$ref": "#/$defs/rangeCheck"
+        }
+      },
+      "additionalProperties": false
+    },
+    "builtinType": {
+      "enum": [
+        "bool",
+        "u8",
+        "u16",
+        "u32",
+        "u64",
+        "i8",
+        "i16",
+        "i32",
+        "i64",
+        "f32",
+        "f64",
+        "char"
+      ]
+    },
+    "integerType": {
+      "enum": [
+        "u8",
+        "u16",
+        "u32",
+        "u64",
+        "i8",
+        "i16",
+        "i32",
+        "i64"
+      ]
+    },
+    "typeRef": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/builtinType"
+        },
+        {
+          "$ref": "#/$defs/identifier"
+        }
+      ]
+    },
+    "occurs": {
+      "type": "object",
+      "description": "Occurrence model: optional field = max 1; array = max N. No count and no fill means exactly `max` occurrences.",
+      "required": [
+        "max"
+      ],
+      "properties": {
+        "min": {
+          "$ref": "#/$defs/intOrExpr"
+        },
+        "max": {
+          "$ref": "#/$defs/intOrExpr"
+        },
+        "count": {
+          "$ref": "#/$defs/intOrExpr",
+          "description": "Number of occurrences present on the wire; 0 means absent."
+        },
+        "fill": {
+          "const": true,
+          "description": "Occurrences fill the remaining payload (last field only)."
+        }
+      },
+      "not": {
+        "required": [
+          "count",
+          "fill"
+        ]
+      },
+      "additionalProperties": false
+    },
+    "checksumCovers": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "from",
+            "to"
+          ],
+          "properties": {
+            "from": {
+              "$ref": "#/$defs/identifier"
+            },
+            "to": {
+              "$ref": "#/$defs/identifier"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "scope"
+          ],
+          "properties": {
+            "scope": {
+              "enum": [
+                "preceding",
+                "payload",
+                "header_and_payload"
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "checksumUse": {
+      "type": "object",
+      "required": [
+        "use",
+        "covers"
+      ],
+      "properties": {
+        "use": {
+          "$ref": "#/$defs/identifier"
+        },
+        "covers": {
+          "$ref": "#/$defs/checksumCovers"
+        }
+      },
+      "additionalProperties": false
+    },
+    "field": {
+      "type": "object",
+      "required": [
+        "name",
+        "type"
+      ],
+      "properties": {
+        "name": {
+          "$ref": "#/$defs/identifier"
+        },
+        "type": {
+          "$ref": "#/$defs/typeRef"
+        },
+        "description": {
+          "type": "string"
+        },
+        "units": {
+          "type": "string"
+        },
+        "bits": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 64
+        },
+        "min": {
+          "$ref": "#/$defs/numOrExpr"
+        },
+        "max": {
+          "$ref": "#/$defs/numOrExpr"
+        },
+        "default": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/scalarValue"
+            },
+            {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/scalarValue"
+              }
+            }
+          ]
+        },
+        "const": {
+          "$ref": "#/$defs/scalarValue"
+        },
+        "reserved": {
+          "type": "boolean"
+        },
+        "occurs": {
+          "$ref": "#/$defs/occurs"
+        },
+        "checksum": {
+          "$ref": "#/$defs/checksumUse"
+        },
+        "role": {
+          "enum": [
+            "message_id",
+            "payload_length",
+            "sync",
+            "protocol_version",
+            "sequence"
+          ]
+        },
+        "if": {
+          "$ref": "#/$defs/expression",
+          "description": "Preprocessor condition; emitted as #if in C++."
+        },
+        "since": {
+          "$ref": "#/$defs/semver"
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "fieldList": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/field"
+      }
+    },
+    "structDef": {
+      "type": "object",
+      "required": [
+        "fields"
+      ],
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "fields": {
+          "$ref": "#/$defs/fieldList"
+        },
+        "if": {
+          "$ref": "#/$defs/expression"
+        },
+        "since": {
+          "$ref": "#/$defs/semver"
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "enumDef": {
+      "type": "object",
+      "required": [
+        "type",
+        "values"
+      ],
+      "properties": {
+        "type": {
+          "$ref": "#/$defs/integerType"
+        },
+        "description": {
+          "type": "string"
+        },
+        "values": {
+          "type": "object",
+          "minProperties": 1,
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "type": "integer"
+          }
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "messageDef": {
+      "type": "object",
+      "required": [
+        "fields"
+      ],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "description": {
+          "type": "string"
+        },
+        "endian": {
+          "$ref": "#/$defs/endian"
+        },
+        "bit_order": {
+          "$ref": "#/$defs/bitOrder"
+        },
+        "range_check": {
+          "$ref": "#/$defs/rangeCheck"
+        },
+        "fields": {
+          "$ref": "#/$defs/fieldList"
+        },
+        "if": {
+          "$ref": "#/$defs/expression"
+        },
+        "since": {
+          "$ref": "#/$defs/semver"
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "checksumDef": {
+      "type": "object",
+      "required": [
+        "algo"
+      ],
+      "properties": {
+        "algo": {
+          "enum": [
+            "crc32",
+            "crc",
+            "custom"
+          ]
+        },
+        "description": {
+          "type": "string"
+        },
+        "width": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 64
+        },
+        "poly": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "init": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "refin": {
+          "type": "boolean"
+        },
+        "refout": {
+          "type": "boolean"
+        },
+        "xorout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "check": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Expected result for ASCII \"123456789\" (self-test)."
+        },
+        "impl": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Fully qualified C++ type satisfying the checksum contract."
+        },
+        "include": {
+          "type": "string",
+          "minLength": 1
+        },
+        "size_bytes": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 16
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "algo": {
+                "const": "crc32"
+              }
+            },
+            "required": [
+              "algo"
+            ]
+          },
+          "then": {
+            "propertyNames": {
+              "not": {
+                "enum": [
+                  "width",
+                  "poly",
+                  "init",
+                  "refin",
+                  "refout",
+                  "xorout",
+                  "check",
+                  "impl",
+                  "include",
+                  "size_bytes"
+                ]
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "algo": {
+                "const": "crc"
+              }
+            },
+            "required": [
+              "algo"
+            ]
+          },
+          "then": {
+            "required": [
+              "width",
+              "poly"
+            ],
+            "propertyNames": {
+              "not": {
+                "enum": [
+                  "impl",
+                  "include",
+                  "size_bytes"
+                ]
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "algo": {
+                "const": "custom"
+              }
+            },
+            "required": [
+              "algo"
+            ]
+          },
+          "then": {
+            "required": [
+              "impl",
+              "include",
+              "size_bytes"
+            ],
+            "propertyNames": {
+              "not": {
+                "enum": [
+                  "width",
+                  "poly",
+                  "init",
+                  "refin",
+                  "refout",
+                  "xorout",
+                  "check"
+                ]
+              }
+            }
+          }
+        }
+      ]
+    },
+    "userTypeDef": {
+      "type": "object",
+      "required": [
+        "cpp",
+        "size_bytes"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "cpp": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Fully qualified C++ type name."
+        },
+        "size_bytes": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "include": {
+          "type": "string",
+          "pattern": "^[^\"<>\\n\\r]+$"
+        },
+        "style": {
+          "enum": [
+            "quote",
+            "angle"
+          ],
+          "default": "quote"
+        },
+        "description": {
+          "type": "string"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      }
+    },
+    "headerDef": {
+      "anyOf": [
+        {
+          "const": "none"
+        },
+        {
+          "type": "object",
+          "required": [
+            "fields"
+          ],
+          "properties": {
+            "fields": {
+              "$ref": "#/$defs/fieldList"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "trailerDef": {
+      "type": "object",
+      "required": [
+        "fields"
+      ],
+      "properties": {
+        "fields": {
+          "$ref": "#/$defs/fieldList"
+        }
+      },
+      "additionalProperties": false
+    },
+    "framing": {
+      "type": "object",
+      "required": [
+        "kind"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "none",
+            "fixed",
+            "sync_length",
+            "length_prefixed"
+          ]
+        },
+        "frame_size": {
+          "$ref": "#/$defs/intOrExpr"
+        },
+        "max_frame_size": {
+          "$ref": "#/$defs/intOrExpr"
+        },
+        "length_counts": {
+          "enum": [
+            "payload",
+            "payload_and_trailer",
+            "frame"
+          ]
+        },
+        "resync": {
+          "type": "boolean"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "const": "fixed"
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "required": [
+              "frame_size"
+            ]
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "enum": [
+                  "sync_length",
+                  "length_prefixed"
+                ]
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "required": [
+              "max_frame_size"
+            ]
+          }
+        }
+      ]
+    },
+    "interfaceMessage": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/identifier"
+        },
+        {
+          "type": "object",
+          "required": [
+            "name"
+          ],
+          "properties": {
+            "name": {
+              "$ref": "#/$defs/identifier"
+            },
+            "id": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "if": {
+              "$ref": "#/$defs/expression"
+            },
+            "since": {
+              "$ref": "#/$defs/semver"
+            },
+            "reqs": {
+              "$ref": "#/$defs/reqs"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "interfaceDef": {
+      "type": "object",
+      "required": [
+        "version",
+        "direction",
+        "messages"
+      ],
+      "properties": {
+        "version": {
+          "$ref": "#/$defs/semver",
+          "description": "ICD version of this interface."
+        },
+        "description": {
+          "type": "string"
+        },
+        "direction": {
+          "enum": [
+            "tx",
+            "rx",
+            "both"
+          ]
+        },
+        "endian": {
+          "$ref": "#/$defs/endian"
+        },
+        "bit_order": {
+          "$ref": "#/$defs/bitOrder"
+        },
+        "range_check": {
+          "$ref": "#/$defs/rangeCheck"
+        },
+        "header": {
+          "$ref": "#/$defs/headerDef"
+        },
+        "trailer": {
+          "$ref": "#/$defs/trailerDef"
+        },
+        "framing": {
+          "$ref": "#/$defs/framing"
+        },
+        "messages": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/interfaceMessage"
+          }
+        },
+        "buffers": {
+          "type": "object",
+          "properties": {
+            "rx_bytes": {
+              "$ref": "#/$defs/intOrExpr"
+            },
+            "tx_bytes": {
+              "$ref": "#/$defs/intOrExpr"
+            }
+          },
+          "additionalProperties": false
+        },
+        "allow_trailing_bytes": {
+          "type": "boolean"
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    },
+    "profileDef": {
+      "type": "object",
+      "required": [
+        "defines"
+      ],
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "defines": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "type": "integer"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "sections": {
+      "type": "object",
+      "properties": {
+        "defines": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "type": "integer"
+          }
+        },
+        "profiles": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/profileDef"
+          }
+        },
+        "checksums": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/checksumDef"
+          }
+        },
+        "enums": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/enumDef"
+          }
+        },
+        "types": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/structDef"
+          }
+        },
+        "user_types": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/userTypeDef"
+          }
+        },
+        "messages": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/messageDef"
+          }
+        },
+        "interfaces": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/interfaceDef"
+          }
+        },
+        "requirements": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/requirementId"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/requirementDef"
+          }
+        },
+        "vectors": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/vectorDef"
+          }
+        }
+      }
+    },
+    "schemaVersion": {
+      "const": 1,
+      "description": "File-format major version. Newer than the tool supports: hard error; older: migrate with `wireforge import`."
+    },
+    "schemaMinor": {
+      "type": "integer",
+      "minimum": 0,
+      "description": "File-format minor version (additive changes only)."
+    },
+    "generator": {
+      "type": "object",
+      "required": [
+        "name",
+        "version"
+      ],
+      "properties": {
+        "name": {
+          "const": "wireforge"
+        },
+        "version": {
+          "$ref": "#/$defs/semver"
+        }
+      },
+      "additionalProperties": false,
+      "description": "WireForge release that wrote this file (informational stamp)."
+    },
+    "bundleInfo": {
+      "type": "object",
+      "required": [
+        "content_hash"
+      ],
+      "properties": {
+        "content_hash": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "sha256 of the canonical definition content."
+        },
+        "source_files": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "userConstant": {
+      "type": "object",
+      "required": [
+        "cpp"
+      ],
+      "properties": {
+        "cpp": {
+          "type": "string",
+          "pattern": "^(::)?[A-Za-z_][A-Za-z0-9_]*(::[A-Za-z_][A-Za-z0-9_]*)*$",
+          "description": "C++ spelling emitted in generated code (constexpr variable, enumerator or macro)."
+        },
+        "value": {
+          "type": "integer",
+          "description": "Value the tools use for analysis, docs and tests; verified against the real constant by a generated static_assert."
+        },
+        "profile_values": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "type": "integer"
+          },
+          "description": "Per-profile override of `value`."
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "userIncludes": {
+      "type": "object",
+      "properties": {
+        "include_dirs": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "description": "Directories added to the include path of generated build files."
+        },
+        "headers": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "path"
+            ],
+            "properties": {
+              "path": {
+                "type": "string",
+                "pattern": "^[^\"<>\\n\\r]+$"
+              },
+              "style": {
+                "enum": [
+                  "quote",
+                  "angle"
+                ]
+              },
+              "if": {
+                "$ref": "#/$defs/expression"
+              }
+            },
+            "additionalProperties": false
+          },
+          "description": "Headers #included by the generated user prelude, in order."
+        },
+        "constants": {
+          "type": "object",
+          "propertyNames": {
+            "$ref": "#/$defs/identifier"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/userConstant"
+          },
+          "description": "Integer constants from user code usable in expressions."
+        },
+        "prelude": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[^\\n\\r]*$"
+          },
+          "description": "Verbatim C++ lines emitted after the headers (e.g. extern declarations). Not analysed by WireForge."
+        }
+      },
+      "additionalProperties": false
+    },
+    "requirementId": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9_.:-]*$",
+      "maxLength": 64
+    },
+    "reqs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/requirementId"
+      },
+      "minItems": 1,
+      "uniqueItems": true,
+      "description": "Ids of the requirements (section `requirements`) this element implements."
+    },
+    "requirementDef": {
+      "type": "object",
+      "required": [
+        "text"
+      ],
+      "properties": {
+        "text": {
+          "type": "string",
+          "minLength": 1
+        },
+        "source": {
+          "type": "string",
+          "description": "Where the requirement comes from (free text, e.g. an ICD section)."
+        },
+        "verification": {
+          "enum": [
+            "test",
+            "analysis",
+            "review"
+          ],
+          "description": "How the requirement is verified (default test)."
+        }
+      },
+      "additionalProperties": false
+    },
+    "vectorDef": {
+      "type": "object",
+      "required": [
+        "message",
+        "bytes",
+        "expect",
+        "reqs"
+      ],
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "interface": {
+          "$ref": "#/$defs/identifier"
+        },
+        "message": {
+          "$ref": "#/$defs/identifier"
+        },
+        "profile": {
+          "$ref": "#/$defs/identifier"
+        },
+        "direction": {
+          "enum": [
+            "decode",
+            "encode",
+            "both"
+          ],
+          "description": "decode (default), encode or both."
+        },
+        "bytes": {
+          "type": "string",
+          "pattern": "^[0-9A-Fa-f _]+$",
+          "description": "Payload (or frame, with `interface`) as hex; spaces and underscores are ignored."
+        },
+        "expect": {
+          "oneOf": [
+            {
+              "type": "object",
+              "required": [
+                "fields"
+              ],
+              "properties": {
+                "fields": {
+                  "type": "object",
+                  "additionalProperties": true,
+                  "description": "Expected field values, in the shape of the decoded message."
+                }
+              },
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "required": [
+                "status"
+              ],
+              "properties": {
+                "status": {
+                  "enum": [
+                    "BufferTooSmall",
+                    "Truncated",
+                    "OutOfRange",
+                    "CountExceedsMax",
+                    "ConstMismatch",
+                    "ChecksumMismatch",
+                    "UnknownMessageId",
+                    "InvalidLength",
+                    "TrailingBytes",
+                    "InvalidState"
+                  ]
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
+        "reqs": {
+          "$ref": "#/$defs/reqs"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}