GitHub Annotations API

openapi: 3.2.0
info:
  version: 1.1.4
  title: github-repos-api Annotations API
  description: 'Use the REST API to create, manage and control the workflow of public and

    private GitHub repositories.'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://docs.github.com/articles/github-terms-of-service
  contact:
    name: Support
    url: https://support.github.com/contact
servers:
- url: '{protocol}://{hostname}'
  variables:
    hostname:
      description: Self-hosted Enterprise Server hostname
      default: api.github.com
    protocol:
      description: Self-hosted Enterprise Server protocol
      default: https
tags:
- name: Annotations
paths:
  /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations:
    get:
      summary: GitHub List Check Run Annotations
      description: 'Lists annotations for a check run using the annotation `id`.


        OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.'
      tags:
      - Annotations
      operationId: listCheckRunAnnotations
      externalDocs:
        description: API method documentation
        url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#list-check-run-annotations
      parameters:
      - $ref: '#/components/parameters/owner'
      - $ref: '#/components/parameters/repo'
      - $ref: '#/components/parameters/check-run-id'
      - $ref: '#/components/parameters/per-page'
      - $ref: '#/components/parameters/page'
      - in: header
        name: Authorization
        schema:
          type: string
        example: example_value
      - in: header
        name: X-GitHub-Api-Version
        schema:
          type: string
          default: '2022-11-28'
        example: example_value
      - in: header
        name: Accept
        schema:
          type: string
          default: application/vnd.github+json
        example: example_value
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/check-annotation'
              examples:
                default:
                  $ref: '#/components/examples/check-annotation-items'
          headers:
            Link:
              $ref: '#/components/headers/link'
      x-github:
        githubCloudOnly: false
        enabledForGitHubApps: true
        category: checks
        subcategory: runs
      security:
      - bearerHttpAuthentication: []
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  examples:
    check-annotation-items:
      value:
      - path: README.md
        start_line: 2
        end_line: 2
        start_column: 5
        end_column: 10
        annotation_level: warning
        title: Spell Checker
        message: Check your spelling for 'banaas'.
        raw_details: Do you mean 'bananas' or 'banana'?
        blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc
  parameters:
    page:
      name: page
      description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 1
    per-page:
      name: per_page
      description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
      in: query
      schema:
        type: integer
        default: 30
    check-run-id:
      name: check_run_id
      description: The unique identifier of the check run.
      in: path
      required: true
      schema:
        type: integer
    owner:
      name: owner
      description: The account owner of the repository. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
    repo:
      name: repo
      description: The name of the repository without the `.git` extension. The name is not case sensitive.
      in: path
      required: true
      schema:
        type: string
  headers:
    link:
      example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"
      schema:
        type: string
  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
        end_column:
          type: integer
          example: 10
        annotation_level:
          type: string
          example: warning
        title:
          type: string
          example: Spell Checker
        message:
          type: string
          example: Check your spelling for 'banaas'.
        raw_details:
          type: string
          example: Do you mean 'bananas' or 'banana'?
        blob_href:
          type: string
          example: https://api.github.com/repos/octocat/Hello-World
      required:
      - path
      - blob_href
      - start_line
      - end_line
      - start_column
      - end_column
      - annotation_level
      - title
      - message
      - raw_details
  securitySchemes:
    bearerHttpAuthentication:
      description: Bearer Token
      type: http
      scheme: Bearer
externalDocs:
  description: GitHub Enterprise Developer Docs
  url: https://docs.github.com/enterprise-server@3.9/rest/