repository_vulnerability_alert dismiss event

APIs.ioEngineeringPlatform

Properties

Name Type Description
action string
alert object The security alert of the vulnerable dependency.
enterprise object
installation object
organization object
repository object
sender object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-webhook-repository-vulnerability-alert-dismiss-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss",
  "title": "repository_vulnerability_alert dismiss event",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "dismiss"
      ]
    },
    "alert": {
      "title": "Repository Vulnerability Alert Alert",
      "description": "The security alert of the vulnerable dependency.",
      "type": "object",
      "required": [
        "affected_package_name",
        "affected_range",
        "created_at",
        "dismiss_reason",
        "dismissed_at",
        "dismisser",
        "external_identifier",
        "external_reference",
        "ghsa_id",
        "id",
        "node_id",
        "number",
        "severity",
        "state"
      ],
      "properties": {
        "affected_package_name": {
          "type": "string"
        },
        "affected_range": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "dismiss_comment": {
          "type": "string",
          "nullable": true
        },
        "dismiss_reason": {
          "type": "string"
        },
        "dismissed_at": {
          "type": "string"
        },
        "dismisser": {
          "title": "User",
          "type": "object",
          "nullable": true,
          "required": [
            "login",
            "id"
          ],
          "properties": {
            "avatar_url": {
              "type": "string",
              "format": "uri"
            },
            "deleted": {
              "type": "boolean"
            },
            "email": {
              "type": "string",
              "nullable": true
            },
            "events_url": {
              "type": "string",
              "format": "uri-template"
            },
            "followers_url": {
              "type": "string",
              "format": "uri"
            },
            "following_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gists_url": {
              "type": "string",
              "format": "uri-template"
            },
            "gravatar_id": {
              "type": "string"
            },
            "html_url": {
              "type": "string",
              "format": "uri"
            },
            "id": {
              "type": "integer"
            },
            "login": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "node_id": {
              "type": "string"
            },
            "organizations_url": {
              "type": "string",
              "format": "uri"
            },
            "received_events_url": {
              "type": "string",
              "format": "uri"
            },
            "repos_url": {
              "type": "string",
              "format": "uri"
            },
            "site_admin": {
              "type": "boolean"
            },
            "starred_url": {
              "type": "string",
              "format": "uri-template"
            },
            "subscriptions_url": {
              "type": "string",
              "format": "uri"
            },
            "type": {
              "type": "string",
              "enum": [
                "Bot",
                "User",
                "Organization"
              ]
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "external_identifier": {
          "type": "string"
        },
        "external_reference": {
          "type": "string",
          "nullable": true,
          "format": "uri"
        },
        "fix_reason": {
          "type": "string"
        },
        "fixed_at": {
          "type": "string",
          "format": "date-time"
        },
        "fixed_in": {
          "type": "string"
        },
        "ghsa_id": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "node_id": {
          "type": "string"
        },
        "number": {
          "type": "integer"
        },
        "severity": {
          "type": "string"
        },
        "state": {
          "type": "string",
          "enum": [
            "dismissed"
          ]
        }
      }
    },
    "enterprise": {
      "$ref": "#/components/schemas/enterprise-webhooks"
    },
    "installation": {
      "$ref": "#/components/schemas/simple-installation"
    },
    "organization": {
      "$ref": "#/components/schemas/organization-simple-webhooks"
    },
    "repository": {
      "$ref": "#/components/schemas/repository-webhooks"
    },
    "sender": {
      "$ref": "#/components/schemas/simple-user-webhooks"
    }
  },
  "required": [
    "action",
    "alert",
    "repository",
    "sender"
  ]
}