GitHub: Checks schemas
9 GitHub schemas with complete fields and constraints.
← Checks operations · All schemas
Create a check run — request body — body actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | A short explanation of what this action would do. The maximum size is 40 characters. Maximum length: 40 |
identifier | string | Required within parent | A reference for the action on the integrator's system. The maximum size is 20 characters. Maximum length: 20 |
label | string | Required within parent | The text to be displayed on a button in the web UI. The maximum size is 20 characters. Maximum length: 20 |
Create a check run — request body — body output annotations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
annotation_level | string | Required within parent | The level of the annotation. One of: notice, warning, failure |
end_column | integer | Optional | The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. |
end_line | integer | Required within parent | The end line of the annotation. |
message | string | Required within parent | A short description of the feedback for these lines of code. The maximum size is 64 KB. |
path | string | Required within parent | The path of the file to add an annotation to. For example, `assets/css/main.css`. |
raw_details | string | Optional | Details about this annotation. The maximum size is 64 KB. |
start_column | integer | Optional | The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. |
start_line | integer | Required within parent | The start line of the annotation. Line numbers start at 1. |
title | string | Optional | The title that represents the annotation. The maximum size is 255 characters. |
Get a check run — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A check performed on the code of a given code change |
app | Model | Required within parent | Expand Get an app — response body |
check_suite | JSON | Required within parent | |
check_suite (anyOf 1) | object | Alternative | |
check_suite (anyOf 1).id | JSON | Required within parent | |
check_suite (anyOf 1).id (anyOf 1) | integer | Alternative | |
check_suite (anyOf 1).id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
check_suite (anyOf 2) | null | Alternative | |
completed_at | JSON | Required within parent | |
completed_at (anyOf 1) | string | Alternative | Format: date-time |
completed_at (anyOf 2) | null | Alternative | |
conclusion | JSON | Required within parent | |
conclusion (anyOf 1) | string | Alternative | Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required |
conclusion (anyOf 2) | null | Alternative | |
deployment | Model | Optional | Expand Get a check run — response body — deployment |
details_url | JSON | Required within parent | |
details_url (anyOf 1) | string | Alternative | |
details_url (anyOf 2) | null | Alternative | |
external_id | JSON | Required within parent | |
external_id (anyOf 1) | string | Alternative | |
external_id (anyOf 2) | null | Alternative | |
head_sha | string | Required within parent | The SHA of the commit that is being checked. |
html_url | JSON | Required within parent | |
html_url (anyOf 1) | string | Alternative | |
html_url (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The id of the check. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the check. |
node_id | string | Required within parent | |
output | object | Required within parent | |
output.annotations_count | JSON | Required within parent | |
output.annotations_count (anyOf 1) | integer | Alternative | |
output.annotations_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
output.annotations_url | string | Required within parent | Format: uri |
output.summary | JSON | Required within parent | |
output.summary (anyOf 1) | string | Alternative | |
output.summary (anyOf 2) | null | Alternative | |
output.text | JSON | Required within parent | |
output.text (anyOf 1) | string | Alternative | |
output.text (anyOf 2) | null | Alternative | |
output.title | JSON | Required within parent | |
output.title (anyOf 1) | string | Alternative | |
output.title (anyOf 2) | null | Alternative | |
pull_requests | array | Required within parent | Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. |
pull_requests[] | Model | Each item | Expand Get a check run — response body — pull requests item |
started_at | JSON | Required within parent | |
started_at (anyOf 1) | string | Alternative | Format: date-time |
started_at (anyOf 2) | null | Alternative | |
status | string | Required within parent | The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. Known values: queued, in_progress, completed, waiting, requested, pending |
url | string | Required within parent |
Referenced models: Get a check run — response body — deployment, Get an app — response body, Get a check run — response body — pull requests item
Get a check run — response body — deployment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A deployment created as the result of an Actions check run from a workflow that references an environment |
created_at | string | Required within parent | Format: date-time |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
environment | string | Required within parent | Name for the target deployment environment. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the deployment |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
original_environment | string | Optional | |
performed_via_github_app | Model | Optional | Expand Get an app — response body |
production_environment | boolean | Optional | Specifies if the given environment is one that end-users directly interact with. Default: false. |
repository_url | string | Required within parent | Format: uri |
statuses_url | string | Required within parent | Format: uri |
task | string | Required within parent | Parameter to specify a task to execute |
transient_environment | boolean | Optional | Specifies if the given environment is will no longer exist at some point in the future. Default: false. |
updated_at | string | Required within parent | Format: date-time |
url | string | Required within parent | Format: uri |
Referenced models: Get an app — response body
Get a check run — response body — pull requests item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base | object | Required within parent | |
base.ref | string | Required within parent | |
base.repo | object | Required within parent | |
base.repo.id | JSON | Required within parent | |
base.repo.id (anyOf 1) | integer | Alternative | Format: int64 |
base.repo.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
base.repo.name | string | Required within parent | |
base.repo.url | string | Required within parent | |
base.sha | string | Required within parent | |
head | object | Required within parent | |
head.ref | string | Required within parent | |
head.repo | object | Required within parent | |
head.repo.id | JSON | Required within parent | |
head.repo.id (anyOf 1) | integer | Alternative | Format: int64 |
head.repo.id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
head.repo.name | string | Required within parent | |
head.repo.url | string | Required within parent | |
head.sha | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number | JSON | Required within parent | |
number (anyOf 1) | integer | Alternative | |
number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
url | string | Required within parent |
Get a check suite — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A suite of checks performed on the code of a given code change |
after | JSON | Required within parent | |
after (anyOf 1) | string | Alternative | |
after (anyOf 2) | null | Alternative | |
app | Model | Required within parent | Expand Get an app — response body |
before | JSON | Required within parent | |
before (anyOf 1) | string | Alternative | |
before (anyOf 2) | null | Alternative | |
check_runs_url | string | Required within parent | |
conclusion | JSON | Required within parent | |
conclusion (anyOf 1) | string | Alternative | Known values: success, failure, neutral, cancelled, skipped, timed_out, action_required, startup_failure, stale |
conclusion (anyOf 2) | null | Alternative | |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
head_branch | JSON | Required within parent | |
head_branch (anyOf 1) | string | Alternative | |
head_branch (anyOf 2) | null | Alternative | |
head_commit | Model | Required within parent | Expand Get a check suite — response body — head commit |
head_sha | string | Required within parent | The SHA of the head commit that is being checked. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
latest_check_runs_count | JSON | Required within parent | |
latest_check_runs_count (anyOf 1) | integer | Alternative | |
latest_check_runs_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
pull_requests | JSON | Required within parent | |
pull_requests (anyOf 1) | array | Alternative | |
pull_requests (anyOf 1)[] | Model | Each item | Expand Get a check run — response body — pull requests item |
pull_requests (anyOf 2) | null | Alternative | |
repository | Model | Required within parent | Expand Transfer a repository — response body |
rerequestable | boolean | Optional | |
runs_rerequestable | boolean | Optional | |
status | JSON | Required within parent | |
status (anyOf 1) | string | Alternative | The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. Known values: queued, in_progress, completed, waiting, requested, pending |
status (anyOf 2) | null | Alternative | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | |
url (anyOf 2) | null | Alternative |
Referenced models: Get an app — response body, Transfer a repository — response body, Get a check run — response body — pull requests item, Get a check suite — response body — head commit
Get a check suite — response body — head commit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A commit. |
author | JSON | Required within parent | |
author (anyOf 1) | object | Alternative | Information about the Git author |
author (anyOf 1).email | string | Required within parent | Git email address of the commit's author Format: email |
author (anyOf 1).name | string | Required within parent | Name of the commit's author |
author (anyOf 2) | null | Alternative | |
committer | JSON | Required within parent | |
committer (anyOf 1) | object | Alternative | Information about the Git committer |
committer (anyOf 1).email | string | Required within parent | Git email address of the commit's committer Format: email |
committer (anyOf 1).name | string | Required within parent | Name of the commit's committer |
committer (anyOf 2) | null | Alternative | |
id | string | Required within parent | SHA for the commit |
message | string | Required within parent | Message describing the purpose of the commit |
timestamp | string | Required within parent | Timestamp of the commit Format: date-time |
tree_id | string | Required within parent | SHA for the commit's tree |
List check run annotations — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Check Annotation |
annotation_level | JSON | Required within parent | |
annotation_level (anyOf 1) | string | Alternative | |
annotation_level (anyOf 2) | null | Alternative | |
blob_href | string | Required within parent | |
end_column | JSON | Required within parent | |
end_column (anyOf 1) | JSON | Alternative | |
end_column (anyOf 1) (anyOf 1) | integer | Alternative | |
end_column (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_column (anyOf 2) | null | Alternative | |
end_line | JSON | Required within parent | |
end_line (anyOf 1) | integer | Alternative | |
end_line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | JSON | Required within parent | |
message (anyOf 1) | string | Alternative | |
message (anyOf 2) | null | Alternative | |
path | string | Required within parent | |
raw_details | JSON | Required within parent | |
raw_details (anyOf 1) | string | Alternative | |
raw_details (anyOf 2) | null | Alternative | |
start_column | JSON | Required within parent | |
start_column (anyOf 1) | JSON | Alternative | |
start_column (anyOf 1) (anyOf 1) | integer | Alternative | |
start_column (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
start_column (anyOf 2) | null | Alternative | |
start_line | JSON | Required within parent | |
start_line (anyOf 1) | integer | Alternative | |
start_line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
title | JSON | Required within parent | |
title (anyOf 1) | string | Alternative | |
title (anyOf 2) | null | Alternative |
Update repository preferences for check suites — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Check suite configuration preferences for a repository. |
preferences | object | Required within parent | |
preferences.auto_trigger_checks | array | Optional | |
preferences.auto_trigger_checks[] | object | Each item | |
preferences.auto_trigger_checks[].app_id | JSON | Required within parent | |
preferences.auto_trigger_checks[].app_id (anyOf 1) | integer | Alternative | |
preferences.auto_trigger_checks[].app_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
preferences.auto_trigger_checks[].setting | boolean | Required within parent | |
repository | Model | Required within parent | Expand Transfer a repository — response body |
Referenced models: Transfer a repository — response body