Annotation — MatRecordJSON Reference

Definition JSON

This fragment is shown exactly as published. Use the chevrons to fold objects and arrays; linked $ref values return to their targets in the complete schema.

{ … }    "type": "object",
    "additionalProperties": false,
    "properties": { … },        "id": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$",
            "minLength": 1,
            "description": "Record-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package."        },
        "document_ref": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "annotator_party_ref": { … },            "type": "string",
            "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"        },
        "annotation_type": { … },            "enum": [ … ]                "reviewer_comment",
                "highlight",
                "redline",
                "handwritten_note",
                "review_stamp",
                "witness_stamp",
                "approval",
                "rejection",
                "other"            ]        },
        "text": { … },            "type": "string"        },
        "date": { … },            "type": "string",
            "format": "date"        },
        "targets": { … },            "type": "array",
            "items": { … },                "$ref": "#/$defs/typed_target"            },
            "minItems": 1        },
        "evidence_refs": { … }            "type": "array",
            "items": { … },                "type": "string",
                "pattern": "^[A-Za-z][A-Za-z0-9._:-]*$"            },
            "minItems": 1,
            "uniqueItems": true        }    },
    "required": [ … ],        "id",
        "document_ref",
        "annotation_type",
        "targets",
        "evidence_refs"    ],
    "description": "A downstream purchaser, inspector, or reviewer markup. It is deliberately separated from issuer-reported source data."}

Fields

Field	Type	Status	Meaning
`id`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Required	Record-local stable identifier. IDs are intended to be unique across the complete MatRecordJSON package.
`document_ref`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Required	Document ref used by this schema object.
`annotator_party_ref`	string — pattern ^[A-Za-z][A-Za-z0-9._:-]*$	Optional	Annotator party ref used by this schema object.
`annotation_type`	enum — "reviewer_comment", "highlight", "redline", "handwritten_note", "review_stamp", "witness_stamp", …	Required	Annotation type used by this schema object.
`text`	string	Optional	Text used by this schema object.
`date`	string	Optional	Date used by this schema object.
`targets`	array — at least 1 item(s)	Required	Targets used by this schema object.
`evidence_refs`	array — at least 1 item(s)	Required	Evidence refs used by this schema object.