---
title: "code-scanning-alert-rule-summary"
url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/code-scanning-alert-rule-summary"
---

> Full API specification: https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4.md

# code-scanning-alert-rule-summary

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: GitHub v3 REST API
  version: 1.1.4
servers:
  - url: "{protocol}://{hostname}/api/v3"
    variables:
      hostname:
        description: Self-hosted Enterprise Server or Enterprise Cloud hostname
        default: HOSTNAME
      protocol:
        description: Self-hosted Enterprise Server or Enterprise Cloud protocol
        default: http
components:
  schemas:
    code-scanning-alert-rule-summary:
      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
        description:
          type: string
          description: A short description of the rule used to detect the alert.
```