{
    "$id": "https://vulnerability.circl.lu/static/schemas/CIRCL/Security_Advisory_Comment.json",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "description": "This schema specifies the format of a comment related to a security advisory.",
    "properties": {
        "creation_timestamp": {
            "description": "When the comment was created originally",
            "format": "datetime-local",
            "options": {
                "hidden": true
            },
            "type": "string"
        },
        "description": {
            "description": "Description of the comment",
            "format": "markdown",
            "title": "Description of the comment",
            "type": "string"
        },
        "description_format": {
            "default": "markdown",
            "description": "Format of the description (markdown or text).",
            "enum": [
                "markdown",
                "text"
            ],
            "type": "string"
        },
        "meta": {
            "description": "Zero or more meta-fields",
            "items": {
                "description": "Meta fields",
                "type": "object"
            },
            "type": "array"
        },
        "related_vulnerabilities": {
            "description": "One or more vulnerability references for this comment.",
            "items": {
                "description": "Vulnerability reference (CVE ID, GHSA-ID, PYSEC ID, etc.).",
                "type": "string"
            },
            "type": "array"
        },
        "timestamp": {
            "description": "When the comment was last updated",
            "format": "datetime-local",
            "options": {
                "hidden": true
            },
            "type": "string"
        },
        "title": {
            "description": "Title of the comment",
            "maxLength": 65535,
            "title": "Title of the comment",
            "type": "string"
        },
        "uuid": {
            "description": "UUIDv4 of the comment",
            "format": "uuid",
            "options": {
                "hidden": true
            },
            "readOnly": true,
            "type": "string"
        },
        "vulnerability": {
            "description": "The identifier of the vulnerability (CVE ID, GHSA-ID, PYSEC ID, etc.).",
            "options": {
                "hidden": true
            },
            "type": "string"
        },
        "vulnerability_lookup_origin": {
            "default": "1a89b78e-f703-45f3-bb86-59eb712668bd",
            "description": "UUIDv4 of the vulnerability lookup instance",
            "options": {
                "hidden": true
            },
            "pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
            "readOnly": true,
            "type": "string"
        }
    },
    "required": [
        "uuid",
        "vulnerability_lookup_origin",
        "creation_timestamp",
        "timestamp",
        "title",
        "description",
        "vulnerability"
    ],
    "title": "Security Advisory comment format.",
    "type": "object"
}