status_combined

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

Overview

Name	status_combined
Type	Resource
Id	github.repos.status_combined

Fields

The following fields are returned by SELECT queries:

get_combined_status_for_ref

Response

Name	Datatype	Description
commit_url	string (uri)
repository	object	Minimal Repository (title: Minimal Repository)
sha	string
state	string
statuses	array
total_count	integer
url	string (uri)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_combined_status_for_ref	select	owner, repo, ref	per_page, page	Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Additionally, a combined state is returned. The state is one of: * failure if any of the contexts report as error or failure * pending if there are no statuses or a context is pending * success if the latest status for all contexts is success

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.
ref	string	The commit reference. Can be a commit SHA, branch name (heads/BRANCH_NAME), or tag name (tags/TAG_NAME). For more information, see "Git References" in the Git documentation.
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

get_combined_status_for_ref

Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.


Additionally, a combined state is returned. The state is one of:

* failure if any of the contexts report as error or failure
* pending if there are no statuses or a context is pending
* success if the latest status for all contexts is success

SELECT
commit_url,
repository,
sha,
state,
statuses,
total_count,
url
FROM github.repos.status_combined
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND ref = '{{ ref }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;