dependabot-alert-security-advisory

Details for the GitHub Security Advisory.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
ghsa_id	string	The unique GitHub Security Advisory ID assigned to the advisory.
cve_id	string	The unique CVE ID assigned to the advisory.
summary	string	A short, plain text summary of the advisory.
description	string	A long-form Markdown-supported description of the advisory.
vulnerabilities	array	Vulnerable version range information for the advisory.
severity	string	The severity of the advisory.
cvss	object	Details for the advisory pertaining to the Common Vulnerability Scoring System.
cwes	array	Details for the advisory pertaining to Common Weakness Enumeration.
identifiers	array	Values that identify this advisory among security information sources.
references	array	Links to additional advisory information.
published_at	string	The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
updated_at	string	The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
withdrawn_at	string	The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/dependabot-alert-security-advisory",
  "title": "dependabot-alert-security-advisory",
  "type": "object",
  "description": "Details for the GitHub Security Advisory.",
  "readOnly": true,
  "properties": {
    "ghsa_id": {
      "type": "string",
      "description": "The unique GitHub Security Advisory ID assigned to the advisory.",
      "readOnly": true
    },
    "cve_id": {
      "type": "string",
      "description": "The unique CVE ID assigned to the advisory.",
      "readOnly": true,
      "nullable": true
    },
    "summary": {
      "type": "string",
      "description": "A short, plain text summary of the advisory.",
      "readOnly": true,
      "maxLength": 1024
    },
    "description": {
      "type": "string",
      "description": "A long-form Markdown-supported description of the advisory.",
      "readOnly": true
    },
    "vulnerabilities": {
      "type": "array",
      "description": "Vulnerable version range information for the advisory.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
      }
    },
    "severity": {
      "type": "string",
      "description": "The severity of the advisory.",
      "readOnly": true,
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ]
    },
    "cvss": {
      "type": "object",
      "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
      "readOnly": true,
      "properties": {
        "score": {
          "type": "number",
          "description": "The overall CVSS score of the advisory.",
          "minimum": 0,
          "maximum": 10,
          "readOnly": true
        },
        "vector_string": {
          "type": "string",
          "description": "The full CVSS vector string for the advisory.",
          "readOnly": true,
          "nullable": true
        }
      },
      "required": [
        "score",
        "vector_string"
      ],
      "additionalProperties": false
    },
    "cwes": {
      "type": "array",
      "description": "Details for the advisory pertaining to Common Weakness Enumeration.",
      "readOnly": true,
      "items": {
        "type": "object",
        "description": "A CWE weakness assigned to the advisory.",
        "readOnly": true,
        "properties": {
          "cwe_id": {
            "type": "string",
            "description": "The unique CWE ID.",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "description": "The short, plain text name of the CWE.",
            "readOnly": true
          }
        },
        "required": [
          "cwe_id",
          "name"
        ],
        "additionalProperties": false
      }
    },
    "identifiers": {
      "type": "array",
      "description": "Values that identify this advisory among security information sources.",
      "readOnly": true,
      "items": {
        "type": "object",
        "description": "An advisory identifier.",
        "readOnly": true,
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of advisory identifier.",
            "readOnly": true,
            "enum": [
              "CVE",
              "GHSA"
            ]
          },
          "value": {
            "type": "string",
            "description": "The value of the advisory identifer.",
            "readOnly": true
          }
        },
        "required": [
          "value",
          "type"
        ],
        "additionalProperties": false
      }
    },
    "references": {
      "type": "array",
      "description": "Links to additional advisory information.",
      "readOnly": true,
      "items": {
        "type": "object",
        "description": "A link to additional advisory information.",
        "readOnly": true,
        "properties": {
          "url": {
            "type": "string",
            "description": "The URL of the reference.",
            "format": "uri",
            "readOnly": true
          }
        },
        "required": [
          "url"
        ],
        "additionalProperties": false
      }
    },
    "published_at": {
      "type": "string",
      "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "withdrawn_at": {
      "type": "string",
      "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true,
      "nullable": true
    }
  },
  "required": [
    "ghsa_id",
    "cve_id",
    "summary",
    "description",
    "vulnerabilities",
    "severity",
    "cvss",
    "cwes",
    "identifiers",
    "references",
    "published_at",
    "updated_at",
    "withdrawn_at"
  ],
  "additionalProperties": false
}