Schema1.1.4object

code-scanning-alert-rule-summary

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

description string

optional

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

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"

Root JSON Schema

{"properties":{"description":{"description":"A short description of the rule used to detect the alert.","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"}},"type":"object"}