annotations

Creates, updates, deletes, gets or lists an annotations resource.

Overview

Name	annotations
Type	Resource
Id	github.checks.annotations

Fields

The following fields are returned by SELECT queries:

list_annotations

Response

Name	Datatype	Description
annotation_level	string	(example: warning)
blob_href	string
end_column	integer
end_line	integer
message	string	(example: Check your spelling for 'banaas'.)
path	string	(example: README.md)
raw_details	string	(example: Do you mean 'bananas' or 'banana'?)
start_column	integer
start_line	integer
title	string	(example: Spell Checker)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_annotations	select	owner, repo, check_run_id	per_page, page	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
check_run_id	integer	The unique identifier of the check run.
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_annotations

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.

SELECT
annotation_level,
blob_href,
end_column,
end_line,
message,
path,
raw_details,
start_column,
start_line,
title
FROM github.checks.annotations
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND check_run_id = '{{ check_run_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;