code-scanning-alert-items

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/main/json-schema/github-code-scanning-alert-items-schema.json",
  "title": "code-scanning-alert-items",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/github-code-scanning-api-openapi.yml#/components/schemas/code-scanning-alert-items",
  "type": "object",
  "properties": {
    "number": {
      "$ref": "#/$defs/alert-number"
    },
    "created_at": {
      "$ref": "#/$defs/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/$defs/alert-updated-at"
    },
    "url": {
      "$ref": "#/$defs/alert-url"
    },
    "html_url": {
      "$ref": "#/$defs/alert-html-url"
    },
    "instances_url": {
      "$ref": "#/$defs/alert-instances-url"
    },
    "state": {
      "$ref": "#/$defs/code-scanning-alert-state"
    },
    "fixed_at": {
      "$ref": "#/$defs/alert-fixed-at"
    },
    "dismissed_by": {
      "$ref": "#/$defs/nullable-simple-user"
    },
    "dismissed_at": {
      "$ref": "#/$defs/alert-dismissed-at"
    },
    "dismissed_reason": {
      "$ref": "#/$defs/code-scanning-alert-dismissed-reason"
    },
    "dismissed_comment": {
      "$ref": "#/$defs/code-scanning-alert-dismissed-comment"
    },
    "rule": {
      "$ref": "#/$defs/code-scanning-alert-rule-summary"
    },
    "tool": {
      "$ref": "#/$defs/code-scanning-analysis-tool"
    },
    "most_recent_instance": {
      "$ref": "#/$defs/code-scanning-alert-instance"
    }
  },
  "required": [
    "number",
    "created_at",
    "url",
    "html_url",
    "instances_url",
    "state",
    "dismissed_by",
    "dismissed_at",
    "dismissed_reason",
    "rule",
    "tool",
    "most_recent_instance"
  ],
  "$defs": {
    "alert-created-at": {
      "type": "string",
      "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "alert-dismissed-at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "alert-fixed-at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "alert-html-url": {
      "type": "string",
      "description": "The GitHub URL of the alert resource.",
      "format": "uri",
      "readOnly": true
    },
    "alert-instances-url": {
      "type": "string",
      "description": "The REST API URL for fetching the list of instances for an alert.",
      "format": "uri",
      "readOnly": true
    },
    "alert-number": {
      "type": "integer",
      "description": "The security alert number.",
      "readOnly": true
    },
    "alert-updated-at": {
      "type": "string",
      "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
      "format": "date-time",
      "readOnly": true
    },
    "alert-url": {
      "type": "string",
      "description": "The REST API URL of the alert resource.",
      "format": "uri",
      "readOnly": true
    },
    "code-scanning-alert-classification": {
      "type": [
        "string",
        "null"
      ],
      "description": "A classification of the file. For example to identify it as generated.",
      "enum": [
        "source",
        "generated",
        "test",
        "library"
      ]
    },
    "code-scanning-alert-dismissed-comment": {
      "type": [
        "string",
        "null"
      ],
      "description": "The dismissal comment associated with the dismissal of the alert.",
      "maxLength": 280
    },
    "code-scanning-alert-dismissed-reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.",
      "enum": [
        null,
        "false positive",
        "won't fix",
        "used in tests"
      ]
    },
    "code-scanning-alert-environment": {
      "type": "string",
      "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
    },
    "code-scanning-alert-instance": {
      "type": "object",
      "properties": {
        "ref": {
          "$ref": "#/$defs/code-scanning-ref"
        },
        "analysis_key": {
          "$ref": "#/$defs/code-scanning-analysis-analysis-key"
        },
        "environment": {
          "$ref": "#/$defs/code-scanning-alert-environment"
        },
        "category": {
          "$ref": "#/$defs/code-scanning-analysis-category"
        },
        "state": {
          "$ref": "#/$defs/code-scanning-alert-state"
        },
        "commit_sha": {
          "type": "string"
        },
        "message": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            }
          }
        },
        "location": {
          "$ref": "#/$defs/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": "#/$defs/code-scanning-alert-classification"
          }
        }
      }
    },
    "code-scanning-alert-location": {
      "type": "object",
      "description": "Describe a region within a file for the alert.",
      "properties": {
        "path": {
          "type": "string"
        },
        "start_line": {
          "type": "integer"
        },
        "end_line": {
          "type": "integer"
        },
        "start_column": {
          "type": "integer"
        },
        "end_column": {
          "type": "integer"
        }
      }
    },
    "code-scanning-alert-rule-summary": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "A unique identifier for the rule used to detect the alert."
        },
        "name": {
          "type": "string",
          "description": "The name of the rule used to detect the alert."
        },
        "tags": {
          "type": [
            "array",
            "null"
          ],
          "description": "A set of tags applicable for the rule.",
          "items": {
            "type": "string"
          }
        },
        "severity": {
          "type": [
            "string",
            "null"
          ],
          "description": "The severity of the alert.",
          "enum": [
            "none",
            "note",
            "warning",
            "error"
          ]
        },
        "security_severity_level": {
          "type": [
            "string",
            "null"
          ],
          "description": "The security severity of the alert.",
          "enum": [
            "low",
            "medium",
            "high",
            "critical"
          ]
        },
        "description": {
          "type": "string",
          "description": "A short description of the rule used to detect the alert."
        }
      }
    },
    "code-scanning-alert-state": {
      "type": "string",
      "description": "State of a code scanning alert.",
      "enum": [
        "open",
        "dismissed",
        "fixed"
      ]
    },
    "code-scanning-analysis-analysis-key": {
      "type": "string",
      "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
    },
    "code-scanning-analysis-category": {
      "type": "string",
      "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
    },
    "code-scanning-analysis-tool": {
      "type": "object",
      "properties": {
        "name": {
          "$ref": "#/$defs/code-scanning-analysis-tool-name"
        },
        "version": {
          "$ref": "#/$defs/code-scanning-analysis-tool-version"
        },
        "guid": {
          "$ref": "#/$defs/code-scanning-analysis-tool-guid"
        }
      }
    },
    "code-scanning-analysis-tool-guid": {
      "type": [
        "string",
        "null"
      ],
      "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
    },
    "code-scanning-analysis-tool-name": {
      "type": "string",
      "description": "The name of the tool used to generate the code scanning analysis."
    },
    "code-scanning-analysis-tool-version": {
      "type": [
        "string",
        "null"
      ],
      "description": "The version of the tool used to generate the code scanning analysis."
    },
    "code-scanning-ref": {
      "type": "string",
      "description": "The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`."
    },
    "nullable-simple-user": {
      "title": "Simple User",
      "description": "A GitHub user.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "login": {
          "type": "string"
        },
        "id": {
          "type": "integer"
        },
        "node_id": {
          "type": "string"
        },
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "gravatar_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string"
        },
        "gists_url": {
          "type": "string"
        },
        "starred_url": {
          "type": "string"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "events_url": {
          "type": "string"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        },
        "type": {
          "type": "string"
        },
        "site_admin": {
          "type": "boolean"
        },
        "starred_at": {
          "type": "string"
        }
      },
      "required": [
        "avatar_url",
        "events_url",
        "followers_url",
        "following_url",
        "gists_url",
        "gravatar_id",
        "html_url",
        "id",
        "node_id",
        "login",
        "organizations_url",
        "received_events_url",
        "repos_url",
        "site_admin",
        "starred_url",
        "subscriptions_url",
        "type",
        "url"
      ]
    }
  }
}