GitHub: Repos schemas (part 3)
21 GitHub schemas with complete fields and constraints.
← Repos operations · All schemas
List CODEOWNERS errors — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of errors found in a repo's CODEOWNERS file |
errors | array | Required within parent | |
errors[] | object | Each item | |
errors[].column | JSON | Required within parent | |
errors[].column (anyOf 1) | integer | Alternative | The column number where this errors occurs. |
errors[].column (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
errors[].kind | string | Required within parent | The type of error. |
errors[].line | JSON | Required within parent | |
errors[].line (anyOf 1) | integer | Alternative | The line number where this errors occurs. |
errors[].line (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
errors[].message | string | Required within parent | A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). |
errors[].path | string | Required within parent | The path of the file where the error occured. |
errors[].source | string | Optional | The contents of the line where the error occurs. |
errors[].suggestion | JSON | Optional | |
errors[].suggestion (anyOf 1) | string | Alternative | Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. |
errors[].suggestion (anyOf 2) | null | Alternative |
List branches for HEAD commit — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Branch Short |
commit | object | Required within parent | |
commit.sha | string | Required within parent | |
commit.url | string | Required within parent | |
name | string | Required within parent | |
protected | boolean | Required within parent |
List branches — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Short Branch |
commit | object | Required within parent | |
commit.sha | string | Required within parent | |
commit.url | string | Required within parent | Format: uri |
name | string | Required within parent | |
protected | boolean | Required within parent | |
protection | Model | Optional | Expand Get branch protection — response body |
protection_url | string | Optional | Format: uri |
Referenced models: Get branch protection — response body
List deliveries for a repository webhook — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Delivery made by a webhook, without request and response information. |
action | JSON | Required within parent | |
action (anyOf 1) | string | Alternative | The type of activity for the event that triggered the delivery. |
action (anyOf 2) | null | Alternative | |
delivered_at | string | Required within parent | Time when the webhook delivery occurred. Format: date-time |
duration | JSON | Required within parent | |
duration (anyOf 1) | number | Alternative | Time spent delivering. |
duration (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
event | string | Required within parent | The event that triggered the delivery. |
guid | string | Required within parent | Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the webhook delivery. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
installation_id | JSON | Required within parent | |
installation_id (anyOf 1) | JSON | Alternative | |
installation_id (anyOf 1) (anyOf 1) | integer | Alternative | The id of the GitHub App installation associated with this event. Format: int64 |
installation_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
installation_id (anyOf 2) | null | Alternative | |
redelivery | boolean | Required within parent | Whether the webhook delivery is a redelivery. |
repository_id | JSON | Required within parent | |
repository_id (anyOf 1) | JSON | Alternative | |
repository_id (anyOf 1) (anyOf 1) | integer | Alternative | The id of the repository associated with this event. Format: int64 |
repository_id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
repository_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Describes the response returned after attempting the delivery. |
status_code | JSON | Required within parent | |
status_code (anyOf 1) | integer | Alternative | Status code received when delivery was made. |
status_code (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
throttled_at | JSON | Optional | |
throttled_at (anyOf 1) | string | Alternative | Time when the webhook delivery was throttled. Format: date-time |
throttled_at (anyOf 2) | null | Alternative |
List repositories for the authenticated user — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A repository on GitHub. |
allow_auto_merge | boolean | Optional | Whether to allow Auto-merge to be used on pull requests. Default: false |
allow_forking | boolean | Optional | Whether to allow forking this repo |
allow_merge_commit | boolean | Optional | Whether to allow merge commits for pull requests. Default: true |
allow_rebase_merge | boolean | Optional | Whether to allow rebase merges for pull requests. Default: true |
allow_squash_merge | boolean | Optional | Whether to allow squash merges for pull requests. Default: true |
allow_update_branch | boolean | Optional | Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. Default: false |
anonymous_access_enabled | boolean | Optional | Whether anonymous git access is enabled for this repository |
archive_url | string | Required within parent | |
archived | boolean | Required within parent | Whether the repository is archived. Default: false |
assignees_url | string | Required within parent | |
blobs_url | string | Required within parent | |
branches_url | string | Required within parent | |
clone_url | string | Required within parent | |
code_search_index_status | object | Optional | The status of the code search index for this repository |
code_search_index_status.lexical_commit_sha | string | Optional | |
code_search_index_status.lexical_search_ok | boolean | Optional | |
collaborators_url | string | Required within parent | |
comments_url | string | Required within parent | |
commits_url | string | Required within parent | |
compare_url | string | Required within parent | |
contents_url | string | Required within parent | |
contributors_url | string | Required within parent | Format: uri |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
default_branch | string | Required within parent | The default branch of the repository. |
delete_branch_on_merge | boolean | Optional | Whether to delete head branches when pull requests are merged Default: false |
deployments_url | string | Required within parent | Format: uri |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disabled | boolean | Required within parent | Returns whether or not this repository disabled. |
downloads_url | string | Required within parent | Format: uri |
events_url | string | Required within parent | Format: uri |
fork | boolean | Required within parent | |
forks | JSON | Required within parent | |
forks (anyOf 1) | integer | Alternative | |
forks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_count | JSON | Required within parent | |
forks_count (anyOf 1) | integer | Alternative | |
forks_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_url | string | Required within parent | Format: uri |
full_name | string | Required within parent | |
git_commits_url | string | Required within parent | |
git_refs_url | string | Required within parent | |
git_tags_url | string | Required within parent | |
git_url | string | Required within parent | |
has_discussions | boolean | Optional | Whether discussions are enabled. Default: false |
has_issues | boolean | Required within parent | Whether issues are enabled. Default: true |
has_pages | boolean | Required within parent | |
has_projects | boolean | Required within parent | Whether projects are enabled. Default: true |
has_pull_requests | boolean | Optional | Whether pull requests are enabled. Default: true |
has_wiki | boolean | Required within parent | Whether the wiki is enabled. Default: true |
homepage | JSON | Required within parent | |
homepage (anyOf 1) | string | Alternative | Format: uri |
homepage (anyOf 2) | null | Alternative | |
hooks_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the repository Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_template | boolean | Optional | Whether this repository acts as a template that can be used to generate new repositories. Default: false |
issue_comment_url | string | Required within parent | |
issue_events_url | string | Required within parent | |
issues_url | string | Required within parent | |
keys_url | string | Required within parent | |
labels_url | string | Required within parent | |
language | JSON | Required within parent | |
language (anyOf 1) | string | Alternative | |
language (anyOf 2) | null | Alternative | |
languages_url | string | Required within parent | Format: uri |
license | Model | Required within parent | Expand Create a fork — response body — license |
merge_commit_message | string | Optional | The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. Known values: PR_BODY, PR_TITLE, BLANK |
merge_commit_title | string | Optional | The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). Known values: PR_TITLE, MERGE_MESSAGE |
merges_url | string | Required within parent | Format: uri |
milestones_url | string | Required within parent | |
mirror_url | JSON | Required within parent | |
mirror_url (anyOf 1) | string | Alternative | Format: uri |
mirror_url (anyOf 2) | null | Alternative | |
name | string | Required within parent | The name of the repository. |
node_id | string | Required within parent | |
notifications_url | string | Required within parent | |
open_issues | JSON | Required within parent | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues_count | JSON | Required within parent | |
open_issues_count (anyOf 1) | integer | Alternative | |
open_issues_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
owner | Model | Required within parent | Expand List users — response body — item |
permissions | object | Optional | |
permissions.admin | boolean | Required within parent | |
permissions.maintain | boolean | Optional | |
permissions.pull | boolean | Required within parent | |
permissions.push | boolean | Required within parent | |
permissions.triage | boolean | Optional | |
private | boolean | Required within parent | Whether the repository is private or public. Default: false |
pull_request_creation_policy | string | Optional | The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only |
pulls_url | string | Required within parent | |
pushed_at | JSON | Required within parent | |
pushed_at (anyOf 1) | string | Alternative | Format: date-time |
pushed_at (anyOf 2) | null | Alternative | |
releases_url | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
squash_merge_commit_message | string | Optional | The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. Known values: PR_BODY, COMMIT_MESSAGES, BLANK |
squash_merge_commit_title | string | Optional | The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). Known values: PR_TITLE, COMMIT_OR_PR_TITLE |
ssh_url | string | Required within parent | |
stargazers_count | JSON | Required within parent | |
stargazers_count (anyOf 1) | integer | Alternative | |
stargazers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stargazers_url | string | Required within parent | Format: uri |
starred_at | string | Optional | |
statuses_url | string | Required within parent | |
subscribers_url | string | Required within parent | Format: uri |
subscription_url | string | Required within parent | Format: uri |
svn_url | string | Required within parent | Format: uri |
tags_url | string | Required within parent | Format: uri |
teams_url | string | Required within parent | Format: uri |
temp_clone_token | string | Optional | When present and non-empty, a temporary credential for read-only Git access to this repository. It expires five minutes after generation and cannot be used to push changes. Treat this value as sensitive and avoid recording it in logs. |
topics | array | Optional | |
topics[] | string | Each item | |
trees_url | string | Required within parent | |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
url | string | Required within parent | Format: uri |
visibility | string | Optional | The repository visibility: public, private, or internal. Default: public |
watchers | JSON | Required within parent | |
watchers (anyOf 1) | integer | Alternative | |
watchers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
watchers_count | JSON | Required within parent | |
watchers_count (anyOf 1) | integer | Alternative | |
watchers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
web_commit_signoff_required | boolean | Optional | Whether to require contributors to sign off on web-based commits Default: false |
Referenced models: Create a fork — response body — license, List users — response body — item
List repository activities — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Activity |
activity_type | string | Required within parent | The type of the activity that was performed. Known values: push, force_push, branch_deletion, branch_creation, pr_merge, merge_queue_merge |
actor | Model | Required within parent | Expand Get an issue — response body — user |
after | string | Required within parent | The SHA of the commit after the activity. |
before | string | Required within parent | The SHA of the commit before the activity. |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
ref | string | Required within parent | The full Git reference, formatted as `refs/heads/<branch name>`. |
timestamp | string | Required within parent | The time when the activity occurred. Format: date-time |
Referenced models: Get an issue — response body — user
List repository collaborators — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Collaborator |
avatar_url | string | Required within parent | Format: uri |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
events_url | string | Required within parent | |
followers_url | string | Required within parent | Format: uri |
following_url | string | Required within parent | |
gists_url | string | Required within parent | |
gravatar_id | JSON | Required within parent | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
html_url | string | Required within parent | Format: uri |
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]+)?$ |
login | string | Required within parent | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | |
organizations_url | string | Required within parent | Format: uri |
permissions | object | Optional | |
permissions.admin | boolean | Required within parent | |
permissions.maintain | boolean | Optional | |
permissions.pull | boolean | Required within parent | |
permissions.push | boolean | Required within parent | |
permissions.triage | boolean | Optional | |
received_events_url | string | Required within parent | Format: uri |
repos_url | string | Required within parent | Format: uri |
role_name | string | Required within parent | |
site_admin | boolean | Required within parent | |
starred_url | string | Required within parent | |
subscriptions_url | string | Required within parent | Format: uri |
type | string | Required within parent | |
url | string | Required within parent | Format: uri |
user_view_type | string | Optional |
List repository contributors — response body — array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contributor |
avatar_url | string | Optional | Format: uri |
contributions | JSON | Required within parent | |
contributions (anyOf 1) | integer | Alternative | |
contributions (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
email | string | Optional | |
events_url | string | Optional | |
followers_url | string | Optional | Format: uri |
following_url | string | Optional | |
gists_url | string | Optional | |
gravatar_id | JSON | Optional | |
gravatar_id (anyOf 1) | string | Alternative | |
gravatar_id (anyOf 2) | null | Alternative | |
html_url | string | Optional | Format: uri |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
login | string | Optional | |
name | string | Optional | |
node_id | string | Optional | |
organizations_url | string | Optional | Format: uri |
received_events_url | string | Optional | Format: uri |
repos_url | string | Optional | Format: uri |
site_admin | boolean | Optional | |
starred_url | string | Optional | |
subscriptions_url | string | Optional | Format: uri |
type | string | Required within parent | |
url | string | Optional | Format: uri |
user_view_type | string | Optional |
List repository languages — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Language Additional keys: see wildcard field |
$.* | JSON | Additional keys | |
$.* (anyOf 1) | integer | Alternative | |
$.* (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List repository rule suites — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | Response |
$[] | object | Each item | |
$[].actor_id | JSON | Optional | |
$[].actor_id (anyOf 1) | integer | Alternative | The number that identifies the user. |
$[].actor_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$[].actor_name | string | Optional | The handle for the GitHub user account. |
$[].after_sha | string | Optional | The last commit sha in the push evaluation. |
$[].before_sha | string | Optional | The first commit sha before the push evaluation. |
$[].evaluation_result | string | Optional | The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Known values: pass, fail, bypass |
$[].id | JSON | Optional | |
$[].id (anyOf 1) | integer | Alternative | The unique identifier of the rule insight. |
$[].id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$[].pushed_at | string | Optional | Format: date-time |
$[].ref | string | Optional | The ref name that the evaluation ran on. |
$[].repository_id | JSON | Optional | |
$[].repository_id (anyOf 1) | integer | Alternative | The ID of the repository associated with the rule evaluation. |
$[].repository_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$[].repository_name | string | Optional | The name of the repository without the `.git` extension. |
$[].result | string | Optional | The result of the rule evaluations for rules with the `active` enforcement status. Known values: pass, fail, bypass |
List repository tags — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tag |
commit | object | Required within parent | |
commit.sha | string | Required within parent | |
commit.url | string | Required within parent | Format: uri |
name | string | Required within parent | |
node_id | string | Required within parent | |
tarball_url | string | Required within parent | Format: uri |
zipball_url | string | Required within parent | Format: uri |
Request a Git Hub Pages build — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Page Build Status |
status | string | Required within parent | |
url | string | Required within parent | Format: uri |
Sync a fork branch with the upstream repository — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Results of a successful merge upstream request |
base_branch | string | Optional | |
merge_type | string | Optional | Known values: merge, fast-forward, none |
message | string | Optional |
Transfer a repository — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Minimal Repository |
allow_forking | boolean | Optional | |
archive_url | string | Required within parent | |
archived | boolean | Optional | |
assignees_url | string | Required within parent | |
blobs_url | string | Required within parent | |
branches_url | string | Required within parent | |
clone_url | string | Optional | |
code_of_conduct | Model | Optional | Expand Get a code of conduct — response body |
collaborators_url | string | Required within parent | |
comments_url | string | Required within parent | |
commits_url | string | Required within parent | |
compare_url | string | Required within parent | |
contents_url | string | Required within parent | |
contributors_url | string | Required within parent | Format: uri |
created_at | JSON | Optional | |
created_at (anyOf 1) | string | Alternative | Format: date-time |
created_at (anyOf 2) | null | Alternative | |
custom_properties | object | Optional | The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. Additional keys: allowed |
default_branch | string | Optional | |
delete_branch_on_merge | boolean | Optional | |
deployments_url | string | Required within parent | Format: uri |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
disabled | boolean | Optional | |
downloads_url | string | Required within parent | Format: uri |
events_url | string | Required within parent | Format: uri |
fork | boolean | Required within parent | |
forks | JSON | Optional | |
forks (anyOf 1) | integer | Alternative | |
forks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_count | JSON | Optional | |
forks_count (anyOf 1) | integer | Alternative | |
forks_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
forks_url | string | Required within parent | Format: uri |
full_name | string | Required within parent | |
git_commits_url | string | Required within parent | |
git_refs_url | string | Required within parent | |
git_tags_url | string | Required within parent | |
git_url | string | Optional | |
has_discussions | boolean | Optional | |
has_issues | boolean | Optional | |
has_pages | boolean | Optional | |
has_projects | boolean | Optional | |
has_pull_requests | boolean | Optional | |
has_wiki | boolean | Optional | |
homepage | JSON | Optional | |
homepage (anyOf 1) | string | Alternative | |
homepage (anyOf 2) | null | Alternative | |
hooks_url | string | Required within parent | Format: uri |
html_url | string | Required within parent | Format: uri |
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]+)?$ |
is_template | boolean | Optional | |
issue_comment_url | string | Required within parent | |
issue_events_url | string | Required within parent | |
issues_url | string | Required within parent | |
keys_url | string | Required within parent | |
labels_url | string | Required within parent | |
language | JSON | Optional | |
language (anyOf 1) | string | Alternative | |
language (anyOf 2) | null | Alternative | |
languages_url | string | Required within parent | Format: uri |
license | JSON | Optional | |
license (anyOf 1) | object | Alternative | |
license (anyOf 1).key | string | Optional | |
license (anyOf 1).name | string | Optional | |
license (anyOf 1).node_id | string | Optional | |
license (anyOf 1).spdx_id | string | Optional | |
license (anyOf 1).url | JSON | Optional | |
license (anyOf 1).url (anyOf 1) | string | Alternative | |
license (anyOf 1).url (anyOf 2) | null | Alternative | |
license (anyOf 2) | null | Alternative | |
merges_url | string | Required within parent | Format: uri |
milestones_url | string | Required within parent | |
mirror_url | JSON | Optional | |
mirror_url (anyOf 1) | string | Alternative | |
mirror_url (anyOf 2) | null | Alternative | |
name | string | Required within parent | |
network_count | JSON | Optional | |
network_count (anyOf 1) | integer | Alternative | |
network_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
node_id | string | Required within parent | |
notifications_url | string | Required within parent | |
open_issues | JSON | Optional | |
open_issues (anyOf 1) | integer | Alternative | |
open_issues (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
open_issues_count | JSON | Optional | |
open_issues_count (anyOf 1) | integer | Alternative | |
open_issues_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
owner | Model | Required within parent | Expand List users — response body — item |
permissions | object | Optional | |
permissions.admin | boolean | Optional | |
permissions.maintain | boolean | Optional | |
permissions.pull | boolean | Optional | |
permissions.push | boolean | Optional | |
permissions.triage | boolean | Optional | |
private | boolean | Required within parent | |
pull_request_creation_policy | string | Optional | The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only |
pulls_url | string | Required within parent | |
pushed_at | JSON | Optional | |
pushed_at (anyOf 1) | string | Alternative | Format: date-time |
pushed_at (anyOf 2) | null | Alternative | |
releases_url | string | Required within parent | |
role_name | string | Optional | |
security_and_analysis | Model | Optional | Expand Create a fork — response body — security and analysis |
size | JSON | Optional | |
size (anyOf 1) | integer | Alternative | The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ssh_url | string | Optional | |
stargazers_count | JSON | Optional | |
stargazers_count (anyOf 1) | integer | Alternative | |
stargazers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
stargazers_url | string | Required within parent | Format: uri |
statuses_url | string | Required within parent | |
subscribers_count | JSON | Optional | |
subscribers_count (anyOf 1) | integer | Alternative | |
subscribers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
subscribers_url | string | Required within parent | Format: uri |
subscription_url | string | Required within parent | Format: uri |
svn_url | string | Optional | |
tags_url | string | Required within parent | Format: uri |
teams_url | string | Required within parent | Format: uri |
temp_clone_token | string | Optional | When present and non-empty, a temporary credential for read-only Git access to this repository. It expires five minutes after generation and cannot be used to push changes. Treat this value as sensitive and avoid recording it in logs. |
topics | array | Optional | |
topics[] | string | Each item | |
trees_url | string | Required within parent | |
updated_at | JSON | Optional | |
updated_at (anyOf 1) | string | Alternative | Format: date-time |
updated_at (anyOf 2) | null | Alternative | |
url | string | Required within parent | Format: uri |
visibility | string | Optional | |
watchers | JSON | Optional | |
watchers (anyOf 1) | integer | Alternative | |
watchers (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
watchers_count | JSON | Optional | |
watchers_count (anyOf 1) | integer | Alternative | |
watchers_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
web_commit_signoff_required | boolean | Optional |
Referenced models: Get a code of conduct — response body, Create a fork — response body — security and analysis, List users — response body — item
Update a deployment branch policy — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | The name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). |
Update a repository invitation — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Repository invitations let you manage who you collaborate with. |
created_at | string | Required within parent | Format: date-time |
expired | boolean | Optional | Whether or not the invitation has expired |
html_url | string | Required within parent | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Unique identifier of the repository invitation. Format: int64 |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
invitee | Model | Required within parent | Expand Get an issue — response body — user |
inviter | Model | Required within parent | Expand Get an issue — response body — user |
node_id | string | Required within parent | |
permissions | string | Required within parent | The permission associated with the invitation. Known values: read, write, admin, triage, triage_plus, maintain |
repository | Model | Required within parent | Expand Transfer a repository — response body |
url | string | Required within parent | URL for the repository invitation |
Referenced models: Transfer a repository — response body, Get an issue — response body — user
Update a repository webhook — request body — body config
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration object of the webhook |
content_type | string | Optional | The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. |
insecure_ssl | Model | Optional | Expand Update a webhook configuration for a repository — request body — body insecure ssl |
secret | string | Optional | If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). |
url | string | Optional | The URL to which the payloads will be delivered. Format: uri |
Referenced models: Update a webhook configuration for a repository — request body — body insecure ssl
Update a webhook configuration for a repository — request body — body insecure ssl
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** |
$ (oneOf 2) | number | Alternative |
Update branch protection — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Branch protections protect branches |
allow_deletions | object | Optional | Additional keys: not allowed |
allow_deletions.enabled | boolean | Required within parent | |
allow_force_pushes | object | Optional | Additional keys: not allowed |
allow_force_pushes.enabled | boolean | Required within parent | |
allow_fork_syncing | object | Optional | Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Additional keys: not allowed |
allow_fork_syncing.enabled | boolean | Optional | Default: false |
block_creations | object | Optional | Additional keys: not allowed |
block_creations.enabled | boolean | Required within parent | |
enforce_admins | object | Optional | Additional keys: not allowed |
enforce_admins.enabled | boolean | Required within parent | |
enforce_admins.url | string | Required within parent | Format: uri |
lock_branch | object | Optional | Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Additional keys: not allowed |
lock_branch.enabled | boolean | Optional | Default: false |
required_conversation_resolution | object | Optional | Additional keys: not allowed |
required_conversation_resolution.enabled | boolean | Optional | |
required_linear_history | object | Optional | Additional keys: not allowed |
required_linear_history.enabled | boolean | Required within parent | |
required_pull_request_reviews | object | Optional | |
required_pull_request_reviews.bypass_pull_request_allowances | object | Optional | |
required_pull_request_reviews.bypass_pull_request_allowances.apps | array | Optional | |
required_pull_request_reviews.bypass_pull_request_allowances.apps[] | Model | Each item | Expand Get an app — response body |
required_pull_request_reviews.bypass_pull_request_allowances.teams | array | Required within parent | |
required_pull_request_reviews.bypass_pull_request_allowances.teams[] | Model | Each item | Expand List teams — response body — item |
required_pull_request_reviews.bypass_pull_request_allowances.users | array | Required within parent | |
required_pull_request_reviews.bypass_pull_request_allowances.users[] | Model | Each item | Expand List users — response body — item |
required_pull_request_reviews.dismiss_stale_reviews | boolean | Optional | |
required_pull_request_reviews.dismissal_restrictions | object | Optional | |
required_pull_request_reviews.dismissal_restrictions.apps | array | Optional | |
required_pull_request_reviews.dismissal_restrictions.apps[] | Model | Each item | Expand Get an app — response body |
required_pull_request_reviews.dismissal_restrictions.teams | array | Required within parent | |
required_pull_request_reviews.dismissal_restrictions.teams[] | Model | Each item | Expand List teams — response body — item |
required_pull_request_reviews.dismissal_restrictions.teams_url | string | Required within parent | Format: uri |
required_pull_request_reviews.dismissal_restrictions.url | string | Required within parent | Format: uri |
required_pull_request_reviews.dismissal_restrictions.users | array | Required within parent | |
required_pull_request_reviews.dismissal_restrictions.users[] | Model | Each item | Expand List users — response body — item |
required_pull_request_reviews.dismissal_restrictions.users_url | string | Required within parent | Format: uri |
required_pull_request_reviews.require_code_owner_reviews | boolean | Optional | |
required_pull_request_reviews.require_last_push_approval | boolean | Optional | Whether the most recent push must be approved by someone other than the person who pushed it. Default: false |
required_pull_request_reviews.required_approving_review_count | JSON | Optional | |
required_pull_request_reviews.required_approving_review_count (anyOf 1) | integer | Alternative | |
required_pull_request_reviews.required_approving_review_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
required_pull_request_reviews.url | string | Required within parent | Format: uri |
required_signatures | object | Optional | |
required_signatures.enabled | boolean | Required within parent | |
required_signatures.url | string | Required within parent | Format: uri |
required_status_checks | Model | Optional | Expand Get status checks protection — response body |
restrictions | Model | Optional | Expand Get access restrictions — response body |
url | string | Required within parent | Format: uri |
Referenced models: Get access restrictions — response body, Get an app — response body, List users — response body — item, Get status checks protection — response body, List teams — response body — item
Update pull request review protection — request body — body bypass pull request allowances
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Allow specific users, teams, or apps to bypass pull request requirements. |
apps | array | Optional | The list of app `slug`s allowed to bypass pull request requirements. |
apps[] | string | Each item | |
teams | array | Optional | The list of team `slug`s allowed to bypass pull request requirements. |
teams[] | string | Each item | |
users | array | Optional | The list of user `login`s allowed to bypass pull request requirements. |
users[] | string | Each item |
Update pull request review protection — request body — body dismissal restrictions
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. |
apps | array | Optional | The list of app `slug`s with dismissal access |
apps[] | string | Each item | |
teams | array | Optional | The list of team `slug`s with dismissal access |
teams[] | string | Each item | |
users | array | Optional | The list of user `login`s with dismissal access |
users[] | string | Each item |