repo_pull_request_bypass_lists

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

Overview

Name	repo_pull_request_bypass_lists
Type	Resource
Id	github.interactions.repo_pull_request_bypass_lists

Fields

The following fields are returned by SELECT queries:

get_pull_request_bypass_list_for_repo

Response

Name	Datatype	Description
id	integer (int64)
name	string
gravatar_id	string	(example: 41d064eb2195891e12d0413f63227ea7)
node_id	string	(example: MDQ6VXNlcjE=)
avatar_url	string (uri)	(example: https://github.com/images/error/octocat_happy.gif)
email	string
events_url	string	(example: https://api.github.com/users/octocat/events{/privacy})
followers_url	string (uri)	(example: https://api.github.com/users/octocat/followers)
following_url	string	(example: https://api.github.com/users/octocat/following{/other_user})
gists_url	string	(example: https://api.github.com/users/octocat/gists{/gist_id})
html_url	string (uri)	(example: https://github.com/octocat)
login	string	(example: octocat)
organizations_url	string (uri)	(example: https://api.github.com/users/octocat/orgs)
received_events_url	string (uri)	(example: https://api.github.com/users/octocat/received_events)
repos_url	string (uri)	(example: https://api.github.com/users/octocat/repos)
site_admin	boolean
starred_at	string	(example: "2020-07-09T00:17:55Z")
starred_url	string	(example: https://api.github.com/users/octocat/starred{/owner}{/repo})
subscriptions_url	string (uri)	(example: https://api.github.com/users/octocat/subscriptions)
type	string	(example: User)
url	string (uri)	(example: https://api.github.com/users/octocat)
user_view_type	string	(example: public)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pull_request_bypass_list_for_repo	select	owner, repo		Lists the users that are on the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap. Only users with maintainer permissions can view the bypass list.
set_pull_request_bypass_list_for_repo	replace	owner, repo, users		Adds users to the pull request creation cap bypass list for a repository. Users on this list can create pull requests regardless of any configured pull request creation cap. Only users with maintainer permissions can modify the bypass list. You can add a maximum of 100 users per request. The bypass list can only hold a maximum of 100 users.
remove_pull_request_bypass_list_for_repo	delete	owner, repo		Removes users from the pull request creation cap bypass list for a repository. Removed users will be subject to any configured pull request creation cap. Only users with maintainer permissions can modify the bypass list. You can remove a maximum of 100 users per request.

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.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_pull_request_bypass_list_for_repo

Lists the users that are on the pull request creation cap bypass list for a
repository. Users on this list can create pull requests regardless of any
configured pull request creation cap.

Only users with maintainer permissions can view the bypass list.

SELECT
id,
name,
gravatar_id,
node_id,
avatar_url,
email,
events_url,
followers_url,
following_url,
gists_url,
html_url,
login,
organizations_url,
received_events_url,
repos_url,
site_admin,
starred_at,
starred_url,
subscriptions_url,
type,
url,
user_view_type
FROM github.interactions.repo_pull_request_bypass_lists
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;

REPLACE examples

set_pull_request_bypass_list_for_repo

Adds users to the pull request creation cap bypass list for a repository.
Users on this list can create pull requests regardless of any configured
pull request creation cap.

Only users with maintainer permissions can modify the bypass list.
You can add a maximum of 100 users per request.
The bypass list can only hold a maximum of 100 users.

REPLACE github.interactions.repo_pull_request_bypass_lists
SET 
users = '{{ users }}'
WHERE 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND users = '{{ users }}' --required;

DELETE examples

remove_pull_request_bypass_list_for_repo

Removes users from the pull request creation cap bypass list for a repository.
Removed users will be subject to any configured pull request creation cap.

Only users with maintainer permissions can modify the bypass list.
You can remove a maximum of 100 users per request.

DELETE FROM github.interactions.repo_pull_request_bypass_lists
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
;