# code-scanning-alert-rule-summary

From **GitHub v3 REST API**.

- Type: `object`

## Properties

### `description`

- Required: false
- Type: `string`

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

### `id`

- Required: false
- Type: `string`
- Nullable: true

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

### `name`

- Required: false
- Type: `string`

The name of the rule used to detect the alert.

### `severity`

- Required: false
- Type: `string`
- Nullable: true
- Allowed values: `"none"`, `"note"`, `"warning"`, `"error"`

The severity of the alert.

## JSON Schema

```json
{"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"}
```