v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2023-07-147873273.9 MB

checks

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.

get/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

check_run_idinteger required

The unique identifier of the check run.

Query parameters

per_pageinteger

The number of results per page (max 100).

pageinteger

Page number of the results to fetch.

Response

pathstring required

start_lineinteger required

end_lineinteger required

start_columninteger nullable required

end_columninteger nullable required

annotation_levelstring nullable required

titlestring nullable required

messagestring nullable required

raw_detailsstring nullable required

blob_hrefstring required

Example response

[
  {
    "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'?"
  }
]