code-scanning-alert-instance

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
ref	object
analysis_key	object
environment	object
category	object
state	object
commit_sha	string
message	object
location	object
html_url	string
classifications	array	Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/code-scanning-alert-instance",
  "title": "code-scanning-alert-instance",
  "type": "object",
  "properties": {
    "ref": {
      "$ref": "#/components/schemas/code-scanning-ref"
    },
    "analysis_key": {
      "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
    },
    "environment": {
      "$ref": "#/components/schemas/code-scanning-alert-environment"
    },
    "category": {
      "$ref": "#/components/schemas/code-scanning-analysis-category"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-state"
    },
    "commit_sha": {
      "type": "string"
    },
    "message": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        }
      }
    },
    "location": {
      "$ref": "#/components/schemas/code-scanning-alert-location"
    },
    "html_url": {
      "type": "string"
    },
    "classifications": {
      "type": "array",
      "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.",
      "items": {
        "$ref": "#/components/schemas/code-scanning-alert-classification"
      }
    }
  }
}