Summary — MatCheckJSON 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,
    "required": [ … ],        "overall_status",
        "finding_counts",
        "requirement_counts",
        "mandatory_counts",
        "aggregation_policy"    ],
    "properties": { … }        "overall_status": { … },            "enum": [ … ]                "pass",
                "pass_with_warnings",
                "incomplete",
                "fail",
                "not_evaluated"            ]        },
        "finding_counts": { … },            "$ref": "#/$defs/finding_counts"        },
        "requirement_counts": { … },            "$ref": "#/$defs/requirement_counts"        },
        "mandatory_counts": { … },            "$ref": "#/$defs/mandatory_counts"        },
        "blocking_finding_refs": { … },            "type": "array",
            "uniqueItems": true,
            "items": { … }                "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/local_id"            }        },
        "unresolved_finding_refs": { … },            "type": "array",
            "uniqueItems": true,
            "items": { … }                "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/local_id"            }        },
        "warning_finding_refs": { … },            "type": "array",
            "uniqueItems": true,
            "items": { … }                "$ref": "https://matjson.org/schema/core/0.1/schema.json#/$defs/local_id"            }        },
        "aggregation_policy": { … },            "$ref": "#/$defs/aggregation_policy"        },
        "rationale": { … }            "type": "string"        }    }}

Fields

Field	Type	Status	Meaning
`overall_status`	enum — "pass", "pass_with_warnings", "incomplete", "fail", "not_evaluated"	Required	Overall status used by this schema object.
`finding_counts`	Finding counts	Required	Finding counts used by this schema object.
`requirement_counts`	Requirement counts	Required	Requirement counts used by this schema object.
`mandatory_counts`	Mandatory counts	Required	Mandatory counts used by this schema object.
`blocking_finding_refs`	array	Optional	Blocking finding refs used by this schema object.
`unresolved_finding_refs`	array	Optional	Unresolved finding refs used by this schema object.
`warning_finding_refs`	array	Optional	Warning finding refs used by this schema object.
`aggregation_policy`	Aggregation policy	Required	Aggregation policy used by this schema object.
`rationale`	string	Optional	Rationale used by this schema object.