---
title: "Check Annotation"
url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/check-annotation"
---

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

# Check Annotation

Check Annotation

## 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:
    check-annotation:
      title: Check Annotation
      description: Check Annotation
      type: object
      properties:
        path:
          type: string
          example: README.md
        start_line:
          type: integer
          example: 2
        end_line:
          type: integer
          example: 2
        start_column:
          type: integer
          example: 5
          nullable: true
        end_column:
          type: integer
          example: 10
          nullable: true
        annotation_level:
          type: string
          example: warning
          nullable: true
        title:
          type: string
          example: Spell Checker
          nullable: true
        message:
          type: string
          example: Check your spelling for 'banaas'.
          nullable: true
        raw_details:
          type: string
          example: Do you mean 'bananas' or 'banana'?
          nullable: true
        blob_href:
          type: string
      required:
        - path
        - blob_href
        - start_line
        - end_line
        - start_column
        - end_column
        - annotation_level
        - title
        - message
        - raw_details
```