PackageDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/checkmarx/main/json-schema/checkmarx-package-details-schema.json",
  "title": "PackageDetails",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/checkmarx-packages-api-openapi.yml#/components/schemas/PackageDetails",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Package ecosystem type"
    },
    "name": {
      "type": "string",
      "description": "Package name"
    },
    "version": {
      "type": "string",
      "description": "Package version"
    },
    "description": {
      "type": "string",
      "description": "Package description"
    },
    "licenses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Package licenses"
    },
    "vulnerabilities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Vulnerability"
      },
      "description": "Known vulnerabilities for this package"
    }
  },
  "$defs": {
    "Vulnerability": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Vulnerability identifier (CVE ID)"
        },
        "cveName": {
          "type": "string",
          "description": "CVE name"
        },
        "score": {
          "type": "number",
          "format": "float",
          "description": "CVSS score"
        },
        "severity": {
          "type": "string",
          "enum": [
            "High",
            "Medium",
            "Low"
          ],
          "description": "Vulnerability severity"
        },
        "publishDate": {
          "type": "string",
          "format": "date-time",
          "description": "Vulnerability publish date"
        },
        "packageId": {
          "type": "string",
          "description": "Affected package identifier"
        },
        "description": {
          "type": "string",
          "description": "Vulnerability description"
        },
        "recommendations": {
          "type": "string",
          "description": "Recommended remediation"
        },
        "cwe": {
          "type": "string",
          "description": "CWE identifier"
        },
        "isIgnored": {
          "type": "boolean",
          "description": "Whether the vulnerability has been marked as ignored"
        },
        "references": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          },
          "description": "External reference URLs"
        }
      }
    }
  }
}