Rule

One atomic material-related rule that can be independently activated, evaluated, and traced to its source.

$defs.rule · 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": [        "id",
        "category",
        "normativity",
        "targets",
        "activation",
        "requirement",
        "verification",
        "source"    ],
    "properties": {        "id": {            "type": "string",
            "pattern": "^[A-Za-z0-9._:-]+$"        },
        "title": {            "type": "string"        },
        "category": {            "enum": [                "material_selection",
                "product_form",
                "chemistry",
                "mechanical",
                "impact",
                "hardness",
                "metallurgy",
                "corrosion_testing",
                "heat_treatment",
                "manufacturing",
                "welding_consumable",
                "fabrication",
                "nde",
                "pmi",
                "documentation",
                "traceability",
                "marking",
                "dimensions",
                "external_standard",
                "other"            ]        },
        "normativity": {            "$ref": "#/$defs/normativity"        },
        "targets": {            "$ref": "#/$defs/targets"        },
        "activation": {            "$ref": "#/$defs/activation"        },
        "requirement": {            "$ref": "#/$defs/requirement"        },
        "effect": {            "$ref": "#/$defs/effect"        },
        "verification": {            "$ref": "#/$defs/verification"        },
        "dependencies": {            "$ref": "#/$defs/dependencies"        },
        "references": {            "type": "array",
            "items": {                "$ref": "#/$defs/document_reference"            }        },
        "source": {            "$ref": "#/$defs/source_ref"        },
        "notes": {            "type": "array",
            "items": {                "type": "string"            }        },
        "group_id": {            "type": "string"        },
        "structured_level": {            "enum": [                "fully_structured",
                "partially_structured",
                "text_preserved",
                "lookup_required"            ]        },
        "sources": {            "type": "array",
            "minItems": 1,
            "items": {                "$ref": "#/$defs/source_ref"            }        },
        "extensions": {            "type": "object",
            "additionalProperties": true,
            "propertyNames": {                "pattern": "^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$",
                "description": "Direct rule-extension keys use lowercase snake_case."            }        }    }}

Fields

FieldTypeStatusMeaning
idstring — pattern ^[A-Za-z0-9._:-]+$RequiredStable rule identifier used for invocation, dependencies, checking, and result traceability.
titlestringOptionalShort human-readable statement of the rule.
categoryenum — "material_selection", "product_form", "chemistry", "mechanical", "impact", "hardness", …RequiredControlled material-requirement category used for filtering and downstream processing.
normativityNormativityRequiredThe source document's normative strength and modal wording, kept separate from project activation.
targetsTargetsRequiredMaterials, grades, product forms, equipment components, weld regions, sides, services, and fabrication states to which a rule can apply.
activationActivationRequiredHow a rule becomes active for a purchase, including always-active, conditionally active, purchaser-invoked, or scoped invocation.
requirementRequirementRequiredThe typed behavior imposed by the rule, such as a limit, test, examination, heat treatment, document field, prohibition, or decision procedure.
effectEffectOptionalHow a MatReq rule supplements, restricts, replaces, selects, prohibits, or otherwise interacts with a base MatSpec requirement.
verificationVerificationRequiredEvidence types, checking method, and result behavior used to demonstrate compliance.
dependenciesDependenciesOptionalOther rules, decisions, or external documents needed before this rule can be evaluated.
referencesarrayOptionalExternal documents invoked or used by this rule, together with the precise reference role.
sourceSource refRequiredPrimary source locator for the rule. Use sources when multiple noncontiguous locations jointly establish it.
notesarrayOptionalAdditional interpretation or extraction notes that do not replace the structured rule.
group_idstringOptionalIdentifier linking related atomic rules that originate from one larger source requirement or decision sequence.
structured_levelenum — "fully_structured", "partially_structured", "text_preserved", "lookup_required"OptionalDegree to which the source requirement has been converted into executable structure rather than preserved text or a lookup.
sourcesarray — at least 1 item(s)OptionalOne or more source locations jointly supporting the rule.
extensionsobjectOptionalNamespaced workflow or domain data associated with this rule.