review_requests

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

Overview

Name	review_requests
Type	Resource
Id	github.pulls.review_requests

Fields

The following fields are returned by SELECT queries:

list_requested_reviewers

Response

Name	Datatype	Description
teams	array
users	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_requested_reviewers	select	owner, repo, pull_number		Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
request_reviewers	insert	owner, repo, pull_number, reviewers, team_reviewers		Requests reviews for a pull request from a given set of users and/or teams. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
remove_requested_reviewers	delete	owner, repo, pull_number		Removes review requests from a pull request for a given set of users and/or teams.

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. The name is not case sensitive.
pull_number	integer	The number that identifies the pull request.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

list_requested_reviewers

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

SELECT
teams,
users
FROM github.pulls.review_requests
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND pull_number = '{{ pull_number }}' -- required
;

INSERT examples

request_reviewers

Requests reviews for a pull request from a given set of users and/or teams.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."

INSERT INTO github.pulls.review_requests (
reviewers,
team_reviewers,
owner,
repo,
pull_number
)
SELECT 
'{{ reviewers }}' /* required */,
'{{ team_reviewers }}' /* required */,
'{{ owner }}',
'{{ repo }}',
'{{ pull_number }}'
RETURNING
id,
node_id,
_links,
active_lock_reason,
assignee,
assignees,
author_association,
auto_merge,
base,
body,
closed_at,
comments_url,
commits_url,
created_at,
diff_url,
draft,
head,
html_url,
issue_url,
labels,
locked,
merge_commit_sha,
merged_at,
milestone,
number,
patch_url,
requested_reviewers,
requested_teams,
review_comment_url,
review_comments_url,
state,
statuses_url,
title,
updated_at,
url,
user
;

Manifest

# Description fields are for documentation purposes
- name: review_requests
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the review_requests resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the review_requests resource.
  - name: pull_number
    value: {{ pull_number }}
    description: Required parameter for the review_requests resource.
  - name: reviewers
    value:
      - "{{ reviewers }}"
    description: |
      An array of user `login`s that will be requested.
  - name: team_reviewers
    value:
      - "{{ team_reviewers }}"
    description: |
      An array of team `slug`s that will be requested.

DELETE examples

remove_requested_reviewers

Removes review requests from a pull request for a given set of users and/or teams.

DELETE FROM github.pulls.review_requests
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND pull_number = '{{ pull_number }}' --required
;