dependabot-alert

A Dependabot alert.

APIs.ioEngineeringPlatform

Properties

Name Type Description
number object
state string The state of the Dependabot alert.
dependency object Details for the vulnerable dependency.
security_advisory object
security_vulnerability object
url object
html_url object
created_at object
updated_at object
dismissed_at object
dismissed_by object
dismissed_reason string The reason that the alert was dismissed.
dismissed_comment string An optional comment associated with the alert's dismissal.
fixed_at object
auto_dismissed_at object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-dependabot-alert-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/dependabot-alert",
  "title": "dependabot-alert",
  "type": "object",
  "description": "A Dependabot alert.",
  "properties": {
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "state": {
      "type": "string",
      "description": "The state of the Dependabot alert.",
      "readOnly": true,
      "enum": [
        "auto_dismissed",
        "dismissed",
        "fixed",
        "open"
      ]
    },
    "dependency": {
      "type": "object",
      "description": "Details for the vulnerable dependency.",
      "readOnly": true,
      "properties": {
        "package": {
          "$ref": "#/components/schemas/dependabot-alert-package"
        },
        "manifest_path": {
          "type": "string",
          "description": "The full path to the dependency manifest file, relative to the root of the repository.",
          "readOnly": true
        },
        "scope": {
          "type": "string",
          "description": "The execution scope of the vulnerable dependency.",
          "readOnly": true,
          "nullable": true,
          "enum": [
            "development",
            "runtime"
          ]
        }
      }
    },
    "security_advisory": {
      "$ref": "#/components/schemas/dependabot-alert-security-advisory"
    },
    "security_vulnerability": {
      "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
    },
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "dismissed_reason": {
      "type": "string",
      "description": "The reason that the alert was dismissed.",
      "nullable": true,
      "enum": [
        "fix_started",
        "inaccurate",
        "no_bandwidth",
        "not_used",
        "tolerable_risk"
      ]
    },
    "dismissed_comment": {
      "type": "string",
      "description": "An optional comment associated with the alert's dismissal.",
      "nullable": true,
      "maxLength": 280
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "auto_dismissed_at": {
      "$ref": "#/components/schemas/alert-auto-dismissed-at"
    }
  },
  "required": [
    "number",
    "state",
    "dependency",
    "security_advisory",
    "security_vulnerability",
    "url",
    "html_url",
    "created_at",
    "updated_at",
    "dismissed_at",
    "dismissed_by",
    "dismissed_reason",
    "dismissed_comment",
    "fixed_at"
  ],
  "additionalProperties": false
}