Get a check suite

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

返回响应

🟢200Response

application/json

Body

A suite of checks performed on the code of a given code change

after

string | null

必需

示例值:

d6fde92930d4715a2b49857d24b940956b26d2d3

app

null | allOf {1}

必需

object (GitHub app)

可选

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

before

string | null

必需

示例值:

146e867f55c26428e5f9fade55a9bbf5e95a7912

check_runs_url

string

必需

conclusion

enum<string> | enum<null>

必需

枚举值:

successfailureneutralcancelledskippedtimed_outaction_required

示例值:

neutral

created_at

string <date-time> | null

必需

head_branch

string | null

必需

示例值:

master

head_commit

object (Simple Commit)

必需

Simple Commit

author

object | null

必需

committer

object | null

必需

string

必需

message

string

必需

timestamp

string <date-time>

必需

tree_id

string

必需

head_sha

string

必需

The SHA of the head commit that is being checked.

示例值:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

integer

必需

示例值:

latest_check_runs_count

integer

必需

node_id

string

必需

示例值:

MDEwOkNoZWNrU3VpdGU1

pull_requests

array[object (Pull Request Minimal) {5}] | null

必需

base

object

必需

head

object

必需

integer

必需

number

integer

必需

url

string

必需

repository

object (Minimal Repository)

必需

Minimal Repository

archive_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}

archived

boolean

可选

assignees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/assignees{/user}

blobs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}

branches_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/branches{/branch}

clone_url

string

可选

collaborators_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}

comments_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/comments{/number}

commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/commits{/sha}

compare_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}

contents_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contents/{+path}

contributors_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/contributors

created_at

string <date-time> | null

可选

示例值:

2011-01-26T19:01:12Z

default_branch

string

可选

delete_branch_on_merge

boolean

可选

deployments_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/deployments

description

string | null

必需

示例值:

This your first repo!

disabled

boolean

可选

downloads_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/downloads

events_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/events

fork

boolean

必需

forks

integer

可选

示例值:

forks_count

integer

可选

forks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/forks

full_name

string

必需

示例值:

octocat/Hello-World

git_commits_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}

git_refs_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}

git_tags_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}

git_url

string

可选

has_downloads

boolean

可选

has_issues

boolean

可选

has_pages

boolean

可选

has_projects

boolean

可选

has_wiki

boolean

可选

homepage

string | null

可选

hooks_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/hooks

html_url

string <uri>

必需

示例值:

https://github.com/octocat/Hello-World

integer

必需

示例值:

1296269

is_template

boolean

可选

issue_comment_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}

issue_events_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues/events{/number}

issues_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/issues{/number}

keys_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/keys{/key_id}

labels_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/labels{/name}

language

string | null

可选

languages_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/languages

license

object | null

可选

merges_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/merges

milestones_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/milestones{/number}

mirror_url

string | null

可选

name

string

必需

示例值:

Hello-World

network_count

integer

可选

node_id

string

必需

示例值:

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

notifications_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}

open_issues

integer

可选

示例值:

open_issues_count

integer

可选

owner

object | null | allOf {1}

必需

permissions

object

可选

private

boolean

必需

pulls_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/pulls{/number}

pushed_at

string <date-time> | null

可选

示例值:

2011-01-26T19:06:43Z

releases_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/releases{/id}

size

integer

可选

ssh_url

string

可选

stargazers_count

integer

可选

stargazers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/stargazers

statuses_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/statuses/{sha}

subscribers_count

integer

可选

subscribers_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscribers

subscription_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/subscription

svn_url

string

可选

tags_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/tags

teams_url

string <uri>

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/teams

temp_clone_token

string

可选

template_repository

object | null | allOf {1}

可选

topics

array[string]

可选

trees_url

string

必需

示例值:

http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}

updated_at

string <date-time> | null

可选

示例值:

2011-01-26T19:14:43Z

url

string <uri>

必需

示例值:

https://api.github.com/repos/octocat/Hello-World

visibility

string

可选

watchers

integer

可选

示例值:

watchers_count

integer

可选

status

enum<string> | enum<null>

必需

枚举值:

queuedin_progresscompleted

示例值:

completed

updated_at

string <date-time> | null

必需

url

string | null

必需

示例值:

https://api.github.com/repos/github/hello-world/check-suites/5

请求参数

返回响应