review_threads

Creates, updates, deletes, gets or lists a review_threads resource.

Overview

Name	review_threads
Type	Resource
Id	github.pulls.review_threads

Fields

The following fields are returned by SELECT queries:

list

Response

Name	Datatype	Description
id	string	The GraphQL node ID of the thread.
comments	object	The comments in the thread (total_count, nodes[] with id, url, body, created_at, author.login).
diff_side	string	LEFT or RIGHT.
is_collapsed	boolean
is_outdated	boolean	Whether the thread is on a line that has since changed.
is_resolved	boolean
line	integer	The line in the diff the thread is attached to.
path	string	The file the thread is attached to.
resolved_by	object	The user who resolved the thread (login).
start_line	integer	The first line of a multi-line comment range.
subject_type	string	LINE or FILE.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	owner, repo, pull_number		Review comment threads on a pull request with their resolved / outdated state and the comments in each thread. Backed by the GitHub GraphQL API (pullRequest.reviewThreads); the REST API does not expose thread resolution.

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
owner	string	The account owner of the repository.
pull_number	integer	The number that identifies the pull request.
repo	string	The name of the repository.

SELECT examples

list

Review comment threads on a pull request with their resolved / outdated state and the comments in each thread. Backed by the GitHub GraphQL API (pullRequest.reviewThreads); the REST API does not expose thread resolution.

SELECT
id,
comments,
diff_side,
is_collapsed,
is_outdated,
is_resolved,
line,
path,
resolved_by,
start_line,
subject_type
FROM github.pulls.review_threads
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND pull_number = '{{ pull_number }}' -- required
;