Branch main Contract RuleReference

Contract: Rulereference

Back to Branch Overview

Field	Value
Branch	main
Source	specs/contracts/RuleReference.schema.json
Commit	5b2aac39fcf8
Synced (UTC)	2026-06-21T06:02:23Z

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": "RuleReference",
  "description": "ASH taxonomy-compliant rule reference.",
  "type": "object",
  "properties": {
    "ruleID": {
      "type": "string",
      "pattern": "^ASH-[A-Z]+-[A-Z]+-[0-9]{3}$"
    },
    "sourceReference": {
      "type": "string"
    },
    "ruleFamily": {
      "type": "string"
    }
  },
  "required": [
    "ruleID",
    "sourceReference",
    "ruleFamily"
  ],
  "additionalProperties": false
}