Schema1.1.4object

code-scanning-alert-rule

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

description string

optional

A short description of the rule used to detect the alert.

full_description string

optional

description of the rule used to detect the alert.

help string

optionalnullable

Detailed documentation for the rule as GitHub Flavored Markdown.

id string

optionalnullable

A unique identifier for the rule used to detect the alert.

name string

optional

The name of the rule used to detect the alert.

severity string

optionalnullable

The severity of the alert.

Allowed: "none""note""warning""error"

tags array

optionalnullable

A set of tags applicable for the rule.

Root JSON Schema

{"properties":{"description":{"description":"A short description of the rule used to detect the alert.","type":"string"},"full_description":{"description":"description of the rule used to detect the alert.","type":"string"},"help":{"description":"Detailed documentation for the rule as GitHub Flavored Markdown.","nullable":true,"type":"string"},"id":{"description":"A unique identifier for the rule used to detect the alert.","nullable":true,"type":"string"},"name":{"description":"The name of the rule used to detect the alert.","type":"string"},"severity":{"description":"The severity of the alert.","enum":["none","note","warning","error"],"nullable":true,"type":"string"},"tags":{"description":"A set of tags applicable for the rule.","items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"}