Github API

Getting access, Developing, Testing

Back to Github

List check run annotations

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

Input

type: object properties: parameters: type: object properties: owner: type: string description: The account owner of the repository. The name is not case sensitive. repo: type: string description: The name of the repository. The name is not case sensitive. check_run_id: type: integer description: The unique identifier of the check run. per_page: type: integer default: 30 description: The number of results per page (max 100). page: type: integer default: 1 description: Page number of the results to fetch. required: - owner - repo - check_run_id title: Parameters

Output

type: array items: type: object title: Check Annotation 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