code-scanning-alert-rule

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
id	string	A unique identifier for the rule used to detect the alert.
name	string	The name of the rule used to detect the alert.
severity	string	The severity of the alert.
security_severity_level	string	The security severity of the alert.
description	string	A short description of the rule used to detect the alert.
full_description	string	description of the rule used to detect the alert.
tags	array	A set of tags applicable for the rule.
help	string	Detailed documentation for the rule as GitHub Flavored Markdown.
help_uri	string	A link to the documentation for the rule used to detect the alert.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/code-scanning-alert-rule",
  "title": "code-scanning-alert-rule",
  "type": "object",
  "properties": {
    "id": {
      "nullable": true,
      "type": "string",
      "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."
    },
    "severity": {
      "nullable": true,
      "type": "string",
      "description": "The severity of the alert.",
      "enum": [
        "none",
        "note",
        "warning",
        "error"
      ]
    },
    "security_severity_level": {
      "nullable": true,
      "type": "string",
      "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."
    },
    "full_description": {
      "type": "string",
      "description": "description of the rule used to detect the alert."
    },
    "tags": {
      "nullable": true,
      "type": "array",
      "description": "A set of tags applicable for the rule.",
      "items": {
        "type": "string"
      }
    },
    "help": {
      "nullable": true,
      "type": "string",
      "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
    },
    "help_uri": {
      "nullable": true,
      "type": "string",
      "description": "A link to the documentation for the rule used to detect the alert."
    }
  }
}