Document

Identity and publication metadata for the governing document represented by this MatReq file.

$defs.document · 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": [        "organization",
        "designation",
        "document_type",
        "title",
        "edition"    ],
    "properties": {        "organization": {            "type": "string"        },
        "designation": {            "type": "string",
            "description": "Canonical designation, e.g. API 663, API RP 934-A, API TR 938-C, NACE MR0175/ISO 15156, ASME BPVC Section VIII Division 1."        },
        "aliases": {            "type": "array",
            "description": "Common designations that may appear in material requisitions and special material requirements. Used for reference resolution, not as separate standards.",
            "items": {                "type": "string"            },
            "uniqueItems": true        },
        "document_type": {            "enum": [                "code",
                "standard",
                "specification",
                "recommended_practice",
                "technical_report",
                "service_standard",
                "purchaser_specification",
                "regulation",
                "other"            ]        },
        "title": {            "type": "string"        },
        "edition": {            "$ref": "#/$defs/edition"        }    }}

Fields

FieldTypeStatusMeaning
organizationstringRequiredStandards body, regulator, owner-user, or purchaser that issued the represented document.
designationstringRequiredCanonical designation, e.g. API 663, API RP 934-A, API TR 938-C, NACE MR0175/ISO 15156, ASME BPVC Section VIII Division 1.
aliasesarrayOptionalCommon designations that may appear in material requisitions and special material requirements. Used for reference resolution, not as separate standards.
document_typeenum — "code", "standard", "specification", "recommended_practice", "technical_report", "service_standard", …RequiredNature of the governing publication, used to interpret its role and authority.
titlestringRequiredPublished title of the governing document.
editionEditionRequiredEdition, publication date, addenda, errata, and reaffirmation metadata.