Branch main Contract JsonDocumentReference

Contract: Jsondocumentreference

Back to Branch Overview

Field	Value
Branch	main
Source	specs/contracts/JsonDocumentReference.schema.json
Commit	dfa401fa1826
Synced (UTC)	2026-06-22T10:59:01Z

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": "JsonDocumentReference",
  "description": "Reference to observed, desired, or canonical JSON document.",
  "type": "object",
  "properties": {
    "documentID": {
      "type": "string"
    },
    "role": {
      "type": "string",
      "enum": [
        "OBSERVED",
        "DESIRED",
        "CANONICALIZED",
        "BACKUP"
      ]
    },
    "canonicalHash": {
      "type": "string"
    },
    "sourceReference": {
      "type": "string"
    }
  },
  "required": [
    "documentID",
    "role",
    "canonicalHash",
    "sourceReference"
  ],
  "additionalProperties": false
}