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,
"required": [ "id",
"role",
"uri",
"content_hash" ],
"properties": { "id": { "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/local_id" },
"role": { "enum": [ "matspec",
"matreq",
"matrecord",
"requisition_context",
"other" ] },
"profile": { "enum": [ "matspec",
"matreq",
"matrecord",
"matcheck",
"core" ] },
"profile_version": { "type": "string" },
"uri": { "type": "string",
"format": "uri-reference" },
"content_hash": { "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/content_hash" },
"schema_uri": { "type": "string",
"format": "uri-reference" },
"document_id": { "type": "string" },
"title": { "type": "string" },
"designation": { "type": "string" },
"edition": { "type": "string" },
"retrieved_at": { "type": "string",
"format": "date-time" },
"embedded_path": { "type": "string" },
"notes": { "type": "array",
"items": { "type": "string" } } },
"allOf": [ { "if": { "properties": { "role": { "const": "matspec" } },
"required": [ "role" ] },
"then": { "required": [ "profile",
"profile_version" ],
"properties": { "profile": { "const": "matspec" } } } },
{ "if": { "properties": { "role": { "const": "matreq" } },
"required": [ "role" ] },
"then": { "required": [ "profile",
"profile_version" ],
"properties": { "profile": { "const": "matreq" } } } },
{ "if": { "properties": { "role": { "const": "matrecord" } },
"required": [ "role" ] },
"then": { "required": [ "profile",
"profile_version" ],
"properties": { "profile": { "const": "matrecord" } } } } ]}Fields
| Field | Type | Status | Meaning |
|---|---|---|---|
id | Local id | Required | Stable identifier for this object within its containing MatJSON document. |
role | enum — "matspec", "matreq", "matrecord", "requisition_context", "other" | Required | Role used by this schema object. |
profile | enum — "matspec", "matreq", "matrecord", "matcheck", "core" | Optional | Profile used by this schema object. |
profile_version | string | Optional | Profile version used by this schema object. |
uri | string | Required | Uri used by this schema object. |
content_hash | Content hash | Required | Content hash used by this schema object. |
schema_uri | string | Optional | Schema uri used by this schema object. |
document_id | string | Optional | Document id used by this schema object. |
title | string | Optional | Short human-readable name displayed in documentation and review tools. |
designation | string | Optional | Designation used by this schema object. |
edition | string | Optional | Edition used by this schema object. |
retrieved_at | string | Optional | Retrieved at used by this schema object. |
embedded_path | string | Optional | Embedded path used by this schema object. |
notes | array | Optional | Additional explanatory notes that do not replace the structured requirement. |