Requirement ref

Stable reference to an atomic requirement. MatSpecJSON v0.2 commonly uses content hash plus JSON Pointer; MatReqJSON v0.2 normally uses rule_id.

$defs.requirement_ref · object

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": [        "input_ref",
        "profile"    ],
    "properties": {        "input_ref": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/local_id"        },
        "profile": {            "enum": [                "matspec",
                "matreq"            ]        },
        "requirement_id": {            "type": "string",
            "minLength": 1        },
        "json_pointer": {            "type": "string",
            "pattern": "^/"        },
        "grade_id": {            "type": "string"        },
        "rule_id": {            "type": "string"        },
        "source": {            "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/standard_reference"        },
        "label": {            "type": "string"        }    },
    "anyOf": [        {            "required": [                "requirement_id"            ]        },
        {            "required": [                "json_pointer"            ]        },
        {            "required": [                "rule_id"            ]        }    ],
    "description": "Stable reference to an atomic requirement. MatSpecJSON v0.2 commonly uses content hash plus JSON Pointer; MatReqJSON v0.2 normally uses rule_id."}

Fields

FieldTypeStatusMeaning
input_refLocal idRequiredInput ref used by this schema object.
profileenum — "matspec", "matreq"RequiredProfile used by this schema object.
requirement_idstringOptionalRequirement id used by this schema object.
json_pointerstring — pattern ^/OptionalJson pointer used by this schema object.
grade_idstringOptionalGrade id used by this schema object.
rule_idstringOptionalRule id used by this schema object.
sourceStandard referenceOptionalReusable provenance for a requirement, value, evidence item, or result.
labelstringOptionalLabel used by this schema object.