PullRequestEntity

A resolved pull request entity from GitHub.

Properties

data

data: object

url

url: string

Format: uri

Example

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

id

id: number

Format: int64

Example

1

node_id

node_id: string

Example

MDExOlB1bGxSZXF1ZXN0MQ==

html_url

html_url: string

Format: uri

Example

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

diff_url

diff_url: string

Format: uri

Example

https://github.com/octocat/Hello-World/pull/1347.diff

patch_url

patch_url: string

Format: uri

Example

https://github.com/octocat/Hello-World/pull/1347.patch

issue_url

issue_url: string

Format: uri

Example

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

commits_url

commits_url: string

Format: uri

Example

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

review_comments_url

review_comments_url: string

Format: uri

Example

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

review_comment_url

review_comment_url: string

Example

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

comments_url

comments_url: string

Format: uri

Example

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

statuses_url

statuses_url: string

Format: uri

Example

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

number

number: number

Description

Number uniquely identifying the pull request within its repository.

Example

42

state

state: "open" | "closed"

Description

State of this Pull Request. Either open or closed.

Example

open
@enum {string}

locked

locked: boolean

Example

true

title

title: string

Description

The title of the pull request.

Example

Amazing new feature

user

user: object

user.name?

optional name: string | null

user.email?

optional email: string | null

user.login

login: string

Example

octocat

user.id

id: number

Format: int64

Example

1

user.node_id

node_id: string

Example

MDQ6VXNlcjE=

user.avatar_url

avatar_url: string

Format: uri

Example

https://github.com/images/error/octocat_happy.gif

user.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

user.url

url: string

Format: uri

Example

https://api.github.com/users/octocat

user.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

user.followers_url

followers_url: string

Format: uri

Example

https://api.github.com/users/octocat/followers

user.following_url

following_url: string

Example

https://api.github.com/users/octocat/following{/other_user}

user.gists_url

gists_url: string

Example

https://api.github.com/users/octocat/gists{/gist_id}

user.starred_url

starred_url: string

Example

https://api.github.com/users/octocat/starred{/owner}{/repo}

user.subscriptions_url

subscriptions_url: string

Format: uri

Example

https://api.github.com/users/octocat/subscriptions

user.organizations_url

organizations_url: string

Format: uri

Example

https://api.github.com/users/octocat/orgs

user.repos_url

repos_url: string

Format: uri

Example

https://api.github.com/users/octocat/repos

user.events_url

events_url: string

Example

https://api.github.com/users/octocat/events{/privacy}

user.received_events_url

received_events_url: string

Format: uri

Example

https://api.github.com/users/octocat/received_events

user.type

type: string

Example

User

user.site_admin

site_admin: boolean

user.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:55Z"

user.user_view_type?

optional user_view_type: string

Example

public

body

body: string | null

Example

Please pull these awesome changes

labels

labels: object[]

milestone

milestone: { url: string; html_url: string; labels_url: string; id: number; node_id: string; number: number; state: "open" | "closed"; title: string; description: string | null; creator: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; } | null; open_issues: number; closed_issues: number; created_at: string; updated_at: string; closed_at: string | null; due_on: string | null; } | null

Type Declaration

{ url: string; html_url: string; labels_url: string; id: number; node_id: string; number: number; state: "open" | "closed"; title: string; description: string | null; creator: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; } | null; open_issues: number; closed_issues: number; created_at: string; updated_at: string; closed_at: string | null; due_on: string | null; }

null

active_lock_reason?

optional active_lock_reason: string | null

Example

too heated

created_at

created_at: string

Format: date-time

Example

2011-01-26T19:01:12Z

updated_at

updated_at: string

Format: date-time

Example

2011-01-26T19:01:12Z

closed_at

closed_at: string | null

Format: date-time

Example

2011-01-26T19:01:12Z

merged_at

merged_at: string | null

Format: date-time

Example

2011-01-26T19:01:12Z

merge_commit_sha

merge_commit_sha: string | null

Example

e5bd3914e2e596debea16f433f57875b5b90bcd6

assignee

assignee: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; } | null

Type Declaration

{ name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; }

null

assignees?

optional assignees: object[] | null

requested_reviewers?

optional requested_reviewers: object[] | null

requested_teams?

optional requested_teams: object[] | null

head

head: object

head.label

label: string

head.ref

ref: string

head.repo

repo: object

head.repo.id

id: number

Format: int64

Description

Unique identifier of the repository

Example

42

head.repo.node_id

node_id: string

Example

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

head.repo.name

name: string

Description

The name of the repository.

Example

Team Environment

head.repo.full_name

full_name: string

Example

octocat/Hello-World

head.repo.license

license: { key: string; name: string; url: string | null; spdx_id: string | null; node_id: string; html_url?: string; } | null

Type Declaration

{ key: string; name: string; url: string | null; spdx_id: string | null; node_id: string; html_url?: string; }

null

head.repo.forks

forks: number

head.repo.permissions?

optional permissions: object

head.repo.permissions.admin

admin: boolean

head.repo.permissions.pull

pull: boolean

head.repo.permissions.triage?

optional triage: boolean

head.repo.permissions.push

push: boolean

head.repo.permissions.maintain?

optional maintain: boolean

head.repo.owner

owner: object

head.repo.owner.name?

optional name: string | null

head.repo.owner.email?

optional email: string | null

head.repo.owner.login

login: string

Example

octocat

head.repo.owner.id

id: number

Format: int64

Example

1

head.repo.owner.node_id

node_id: string

Example

MDQ6VXNlcjE=

head.repo.owner.avatar_url

avatar_url: string

Format: uri

Example

https://github.com/images/error/octocat_happy.gif

head.repo.owner.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

head.repo.owner.url

url: string

Format: uri

Example

https://api.github.com/users/octocat

head.repo.owner.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

head.repo.owner.followers_url

followers_url: string

Format: uri

Example

https://api.github.com/users/octocat/followers

head.repo.owner.following_url

following_url: string

Example

https://api.github.com/users/octocat/following{/other_user}

head.repo.owner.gists_url

gists_url: string

Example

https://api.github.com/users/octocat/gists{/gist_id}

head.repo.owner.starred_url

starred_url: string

Example

https://api.github.com/users/octocat/starred{/owner}{/repo}

head.repo.owner.subscriptions_url

subscriptions_url: string

Format: uri

Example

https://api.github.com/users/octocat/subscriptions

head.repo.owner.organizations_url

organizations_url: string

Format: uri

Example

https://api.github.com/users/octocat/orgs

head.repo.owner.repos_url

repos_url: string

Format: uri

Example

https://api.github.com/users/octocat/repos

head.repo.owner.events_url

events_url: string

Example

https://api.github.com/users/octocat/events{/privacy}

head.repo.owner.received_events_url

received_events_url: string

Format: uri

Example

https://api.github.com/users/octocat/received_events

head.repo.owner.type

type: string

Example

User

head.repo.owner.site_admin

site_admin: boolean

head.repo.owner.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:55Z"

head.repo.owner.user_view_type?

optional user_view_type: string

Example

public

head.repo.private

private: boolean

Description

Whether the repository is private or public.

Default

false

head.repo.html_url

html_url: string

Format: uri

Example

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

head.repo.description

description: string | null

Example

This your first repo!

head.repo.fork

fork: boolean

head.repo.url

url: string

Format: uri

Example

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

head.repo.archive_url

archive_url: string

Example

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

head.repo.assignees_url

assignees_url: string

Example

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

head.repo.blobs_url

blobs_url: string

Example

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

head.repo.branches_url

branches_url: string

Example

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

head.repo.collaborators_url

collaborators_url: string

Example

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

head.repo.comments_url

comments_url: string

Example

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

head.repo.commits_url

commits_url: string

Example

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

head.repo.compare_url

compare_url: string

Example

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

head.repo.contents_url

contents_url: string

Example

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

head.repo.contributors_url

contributors_url: string

Format: uri

Example

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

head.repo.deployments_url

deployments_url: string

Format: uri

Example

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

head.repo.downloads_url

downloads_url: string

Format: uri

Example

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

head.repo.events_url

events_url: string

Format: uri

Example

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

head.repo.forks_url

forks_url: string

Format: uri

Example

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

head.repo.git_commits_url

git_commits_url: string

Example

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

head.repo.git_refs_url

git_refs_url: string

Example

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

head.repo.git_tags_url

git_tags_url: string

Example

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

head.repo.git_url

git_url: string

Example

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

head.repo.issue_comment_url

issue_comment_url: string

Example

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

head.repo.issue_events_url

issue_events_url: string

Example

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

head.repo.issues_url

issues_url: string

Example

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

head.repo.keys_url

keys_url: string

Example

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

head.repo.labels_url

labels_url: string

Example

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

head.repo.languages_url

languages_url: string

Format: uri

Example

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

head.repo.merges_url

merges_url: string

Format: uri

Example

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

head.repo.milestones_url

milestones_url: string

Example

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

head.repo.notifications_url

notifications_url: string

Example

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

head.repo.pulls_url

pulls_url: string

Example

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

head.repo.releases_url

releases_url: string

Example

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

head.repo.ssh_url

ssh_url: string

Example

git@github.com:octocat/Hello-World.git

head.repo.stargazers_url

stargazers_url: string

Format: uri

Example

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

head.repo.statuses_url

statuses_url: string

Example

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

head.repo.subscribers_url

subscribers_url: string

Format: uri

Example

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

head.repo.subscription_url

subscription_url: string

Format: uri

Example

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

head.repo.tags_url

tags_url: string

Format: uri

Example

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

head.repo.teams_url

teams_url: string

Format: uri

Example

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

head.repo.trees_url

trees_url: string

Example

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

head.repo.clone_url

clone_url: string

Example

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

head.repo.mirror_url

mirror_url: string | null

Format: uri

Example

git:git.example.com/octocat/Hello-World

head.repo.hooks_url

hooks_url: string

Format: uri

Example

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

head.repo.svn_url

svn_url: string

Format: uri

Example

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

head.repo.homepage

homepage: string | null

Format: uri

Example

https://github.com

head.repo.language

language: string | null

head.repo.forks_count

forks_count: number

Example

9

head.repo.stargazers_count

stargazers_count: number

Example

80

head.repo.watchers_count

watchers_count: number

Example

80

head.repo.size

size: number

Description

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

Example

108

head.repo.default_branch

default_branch: string

Description

The default branch of the repository.

Example

master

head.repo.open_issues_count

open_issues_count: number

Example

0

head.repo.is_template?

optional is_template: boolean

Description

Whether this repository acts as a template that can be used to generate new repositories.

Default

false

Example

true

head.repo.topics?

optional topics: string[]

head.repo.has_issues

has_issues: boolean

Description

Whether issues are enabled.

Default

true

Example

true

head.repo.has_projects

has_projects: boolean

Description

Whether projects are enabled.

Default

true

Example

true

head.repo.has_wiki

has_wiki: boolean

Description

Whether the wiki is enabled.

Default

true

Example

true

head.repo.has_pages

has_pages: boolean

head.repo.has_downloads

has_downloads: boolean

Deprecated

This API is no longer supported and may be removed in a future release.

Description

Whether downloads are enabled.

Default

true

Example

true

head.repo.has_discussions?

optional has_discussions: boolean

Description

Whether discussions are enabled.

Default

false

Example

true

head.repo.archived

archived: boolean

Description

Whether the repository is archived.

Default

false

head.repo.disabled

disabled: boolean

Description

Returns whether or not this repository disabled.

head.repo.visibility?

optional visibility: string

Description

The repository visibility: public, private, or internal.

Default

public

head.repo.pushed_at

pushed_at: string | null

Format: date-time

Example

2011-01-26T19:06:43Z

head.repo.created_at

created_at: string | null

Format: date-time

Example

2011-01-26T19:01:12Z

head.repo.updated_at

updated_at: string | null

Format: date-time

Example

2011-01-26T19:14:43Z

head.repo.allow_rebase_merge?

optional allow_rebase_merge: boolean

Description

Whether to allow rebase merges for pull requests.

Default

true

Example

true

head.repo.temp_clone_token?

optional temp_clone_token: string

head.repo.allow_squash_merge?

optional allow_squash_merge: boolean

Description

Whether to allow squash merges for pull requests.

Default

true

Example

true

head.repo.allow_auto_merge?

optional allow_auto_merge: boolean

Description

Whether to allow Auto-merge to be used on pull requests.

Default

false

Example

false

head.repo.delete_branch_on_merge?

optional delete_branch_on_merge: boolean

Description

Whether to delete head branches when pull requests are merged

Default

false

Example

false

head.repo.allow_update_branch?

optional allow_update_branch: boolean

Description

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

Example

false

head.repo.use_squash_pr_title_as_default?

optional use_squash_pr_title_as_default: boolean

Deprecated

This API is no longer supported and may be removed in a future release.

Description

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

Default

false

head.repo.squash_merge_commit_title?

optional squash_merge_commit_title: "PR_TITLE" | "COMMIT_OR_PR_TITLE"

Description

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).

head.repo.squash_merge_commit_message?

optional squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"

Description

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.

head.repo.merge_commit_title?

optional merge_commit_title: "PR_TITLE" | "MERGE_MESSAGE"

Description

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).

head.repo.merge_commit_message?

optional merge_commit_message: "PR_TITLE" | "PR_BODY" | "BLANK"

Description

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.

head.repo.allow_merge_commit?

optional allow_merge_commit: boolean

Description

Whether to allow merge commits for pull requests.

Default

true

Example

true

head.repo.allow_forking?

optional allow_forking: boolean

Description

Whether to allow forking this repo

head.repo.web_commit_signoff_required?

optional web_commit_signoff_required: boolean

Description

Whether to require contributors to sign off on web-based commits

Default

false

head.repo.open_issues

open_issues: number

head.repo.watchers

watchers: number

head.repo.master_branch?

optional master_branch: string

head.repo.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:42Z"

head.repo.anonymous_access_enabled?

optional anonymous_access_enabled: boolean

Description

Whether anonymous git access is enabled for this repository

head.repo.code_search_index_status?

optional code_search_index_status: object

Description

The status of the code search index for this repository

head.repo.code_search_index_status.lexical_search_ok?

optional lexical_search_ok: boolean

head.repo.code_search_index_status.lexical_commit_sha?

optional lexical_commit_sha: string

head.sha

sha: string

head.user

user: object

head.user.name?

optional name: string | null

head.user.email?

optional email: string | null

head.user.login

login: string

Example

octocat

head.user.id

id: number

Format: int64

Example

1

head.user.node_id

node_id: string

Example

MDQ6VXNlcjE=

head.user.avatar_url

avatar_url: string

Format: uri

Example

https://github.com/images/error/octocat_happy.gif

head.user.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

head.user.url

url: string

Format: uri

Example

https://api.github.com/users/octocat

head.user.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

head.user.followers_url

followers_url: string

Format: uri

Example

https://api.github.com/users/octocat/followers

head.user.following_url

following_url: string

Example

https://api.github.com/users/octocat/following{/other_user}

head.user.gists_url

gists_url: string

Example

https://api.github.com/users/octocat/gists{/gist_id}

head.user.starred_url

starred_url: string

Example

https://api.github.com/users/octocat/starred{/owner}{/repo}

head.user.subscriptions_url

subscriptions_url: string

Format: uri

Example

https://api.github.com/users/octocat/subscriptions

head.user.organizations_url

organizations_url: string

Format: uri

Example

https://api.github.com/users/octocat/orgs

head.user.repos_url

repos_url: string

Format: uri

Example

https://api.github.com/users/octocat/repos

head.user.events_url

events_url: string

Example

https://api.github.com/users/octocat/events{/privacy}

head.user.received_events_url

received_events_url: string

Format: uri

Example

https://api.github.com/users/octocat/received_events

head.user.type

type: string

Example

User

head.user.site_admin

site_admin: boolean

head.user.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:55Z"

head.user.user_view_type?

optional user_view_type: string

Example

public

base

base: object

base.label

label: string

base.ref

ref: string

base.repo

repo: object

base.repo.id

id: number

Format: int64

Description

Unique identifier of the repository

Example

42

base.repo.node_id

node_id: string

Example

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

base.repo.name

name: string

Description

The name of the repository.

Example

Team Environment

base.repo.full_name

full_name: string

Example

octocat/Hello-World

base.repo.license

license: { key: string; name: string; url: string | null; spdx_id: string | null; node_id: string; html_url?: string; } | null

Type Declaration

{ key: string; name: string; url: string | null; spdx_id: string | null; node_id: string; html_url?: string; }

null

base.repo.forks

forks: number

base.repo.permissions?

optional permissions: object

base.repo.permissions.admin

admin: boolean

base.repo.permissions.pull

pull: boolean

base.repo.permissions.triage?

optional triage: boolean

base.repo.permissions.push

push: boolean

base.repo.permissions.maintain?

optional maintain: boolean

base.repo.owner

owner: object

base.repo.owner.name?

optional name: string | null

base.repo.owner.email?

optional email: string | null

base.repo.owner.login

login: string

Example

octocat

base.repo.owner.id

id: number

Format: int64

Example

1

base.repo.owner.node_id

node_id: string

Example

MDQ6VXNlcjE=

base.repo.owner.avatar_url

avatar_url: string

Format: uri

Example

https://github.com/images/error/octocat_happy.gif

base.repo.owner.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

base.repo.owner.url

url: string

Format: uri

Example

https://api.github.com/users/octocat

base.repo.owner.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

base.repo.owner.followers_url

followers_url: string

Format: uri

Example

https://api.github.com/users/octocat/followers

base.repo.owner.following_url

following_url: string

Example

https://api.github.com/users/octocat/following{/other_user}

base.repo.owner.gists_url

gists_url: string

Example

https://api.github.com/users/octocat/gists{/gist_id}

base.repo.owner.starred_url

starred_url: string

Example

https://api.github.com/users/octocat/starred{/owner}{/repo}

base.repo.owner.subscriptions_url

subscriptions_url: string

Format: uri

Example

https://api.github.com/users/octocat/subscriptions

base.repo.owner.organizations_url

organizations_url: string

Format: uri

Example

https://api.github.com/users/octocat/orgs

base.repo.owner.repos_url

repos_url: string

Format: uri

Example

https://api.github.com/users/octocat/repos

base.repo.owner.events_url

events_url: string

Example

https://api.github.com/users/octocat/events{/privacy}

base.repo.owner.received_events_url

received_events_url: string

Format: uri

Example

https://api.github.com/users/octocat/received_events

base.repo.owner.type

type: string

Example

User

base.repo.owner.site_admin

site_admin: boolean

base.repo.owner.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:55Z"

base.repo.owner.user_view_type?

optional user_view_type: string

Example

public

base.repo.private

private: boolean

Description

Whether the repository is private or public.

Default

false

base.repo.html_url

html_url: string

Format: uri

Example

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

base.repo.description

description: string | null

Example

This your first repo!

base.repo.fork

fork: boolean

base.repo.url

url: string

Format: uri

Example

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

base.repo.archive_url

archive_url: string

Example

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

base.repo.assignees_url

assignees_url: string

Example

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

base.repo.blobs_url

blobs_url: string

Example

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

base.repo.branches_url

branches_url: string

Example

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

base.repo.collaborators_url

collaborators_url: string

Example

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

base.repo.comments_url

comments_url: string

Example

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

base.repo.commits_url

commits_url: string

Example

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

base.repo.compare_url

compare_url: string

Example

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

base.repo.contents_url

contents_url: string

Example

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

base.repo.contributors_url

contributors_url: string

Format: uri

Example

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

base.repo.deployments_url

deployments_url: string

Format: uri

Example

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

base.repo.downloads_url

downloads_url: string

Format: uri

Example

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

base.repo.events_url

events_url: string

Format: uri

Example

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

base.repo.forks_url

forks_url: string

Format: uri

Example

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

base.repo.git_commits_url

git_commits_url: string

Example

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

base.repo.git_refs_url

git_refs_url: string

Example

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

base.repo.git_tags_url

git_tags_url: string

Example

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

base.repo.git_url

git_url: string

Example

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

base.repo.issue_comment_url

issue_comment_url: string

Example

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

base.repo.issue_events_url

issue_events_url: string

Example

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

base.repo.issues_url

issues_url: string

Example

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

base.repo.keys_url

keys_url: string

Example

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

base.repo.labels_url

labels_url: string

Example

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

base.repo.languages_url

languages_url: string

Format: uri

Example

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

base.repo.merges_url

merges_url: string

Format: uri

Example

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

base.repo.milestones_url

milestones_url: string

Example

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

base.repo.notifications_url

notifications_url: string

Example

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

base.repo.pulls_url

pulls_url: string

Example

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

base.repo.releases_url

releases_url: string

Example

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

base.repo.ssh_url

ssh_url: string

Example

git@github.com:octocat/Hello-World.git

base.repo.stargazers_url

stargazers_url: string

Format: uri

Example

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

base.repo.statuses_url

statuses_url: string

Example

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

base.repo.subscribers_url

subscribers_url: string

Format: uri

Example

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

base.repo.subscription_url

subscription_url: string

Format: uri

Example

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

base.repo.tags_url

tags_url: string

Format: uri

Example

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

base.repo.teams_url

teams_url: string

Format: uri

Example

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

base.repo.trees_url

trees_url: string

Example

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

base.repo.clone_url

clone_url: string

Example

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

base.repo.mirror_url

mirror_url: string | null

Format: uri

Example

git:git.example.com/octocat/Hello-World

base.repo.hooks_url

hooks_url: string

Format: uri

Example

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

base.repo.svn_url

svn_url: string

Format: uri

Example

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

base.repo.homepage

homepage: string | null

Format: uri

Example

https://github.com

base.repo.language

language: string | null

base.repo.forks_count

forks_count: number

Example

9

base.repo.stargazers_count

stargazers_count: number

Example

80

base.repo.watchers_count

watchers_count: number

Example

80

base.repo.size

size: number

Description

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

Example

108

base.repo.default_branch

default_branch: string

Description

The default branch of the repository.

Example

master

base.repo.open_issues_count

open_issues_count: number

Example

0

base.repo.is_template?

optional is_template: boolean

Description

Whether this repository acts as a template that can be used to generate new repositories.

Default

false

Example

true

base.repo.topics?

optional topics: string[]

base.repo.has_issues

has_issues: boolean

Description

Whether issues are enabled.

Default

true

Example

true

base.repo.has_projects

has_projects: boolean

Description

Whether projects are enabled.

Default

true

Example

true

base.repo.has_wiki

has_wiki: boolean

Description

Whether the wiki is enabled.

Default

true

Example

true

base.repo.has_pages

has_pages: boolean

base.repo.has_downloads

has_downloads: boolean

Deprecated

This API is no longer supported and may be removed in a future release.

Description

Whether downloads are enabled.

Default

true

Example

true

base.repo.has_discussions?

optional has_discussions: boolean

Description

Whether discussions are enabled.

Default

false

Example

true

base.repo.archived

archived: boolean

Description

Whether the repository is archived.

Default

false

base.repo.disabled

disabled: boolean

Description

Returns whether or not this repository disabled.

base.repo.visibility?

optional visibility: string

Description

The repository visibility: public, private, or internal.

Default

public

base.repo.pushed_at

pushed_at: string | null

Format: date-time

Example

2011-01-26T19:06:43Z

base.repo.created_at

created_at: string | null

Format: date-time

Example

2011-01-26T19:01:12Z

base.repo.updated_at

updated_at: string | null

Format: date-time

Example

2011-01-26T19:14:43Z

base.repo.allow_rebase_merge?

optional allow_rebase_merge: boolean

Description

Whether to allow rebase merges for pull requests.

Default

true

Example

true

base.repo.temp_clone_token?

optional temp_clone_token: string

base.repo.allow_squash_merge?

optional allow_squash_merge: boolean

Description

Whether to allow squash merges for pull requests.

Default

true

Example

true

base.repo.allow_auto_merge?

optional allow_auto_merge: boolean

Description

Whether to allow Auto-merge to be used on pull requests.

Default

false

Example

false

base.repo.delete_branch_on_merge?

optional delete_branch_on_merge: boolean

Description

Whether to delete head branches when pull requests are merged

Default

false

Example

false

base.repo.allow_update_branch?

optional allow_update_branch: boolean

Description

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

Example

false

base.repo.use_squash_pr_title_as_default?

optional use_squash_pr_title_as_default: boolean

Deprecated

This API is no longer supported and may be removed in a future release.

Description

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

Default

false

base.repo.squash_merge_commit_title?

optional squash_merge_commit_title: "PR_TITLE" | "COMMIT_OR_PR_TITLE"

Description

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).

base.repo.squash_merge_commit_message?

optional squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"

Description

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.

base.repo.merge_commit_title?

optional merge_commit_title: "PR_TITLE" | "MERGE_MESSAGE"

Description

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).

base.repo.merge_commit_message?

optional merge_commit_message: "PR_TITLE" | "PR_BODY" | "BLANK"

Description

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.

base.repo.allow_merge_commit?

optional allow_merge_commit: boolean

Description

Whether to allow merge commits for pull requests.

Default

true

Example

true

base.repo.allow_forking?

optional allow_forking: boolean

Description

Whether to allow forking this repo

base.repo.web_commit_signoff_required?

optional web_commit_signoff_required: boolean

Description

Whether to require contributors to sign off on web-based commits

Default

false

base.repo.open_issues

open_issues: number

base.repo.watchers

watchers: number

base.repo.master_branch?

optional master_branch: string

base.repo.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:42Z"

base.repo.anonymous_access_enabled?

optional anonymous_access_enabled: boolean

Description

Whether anonymous git access is enabled for this repository

base.repo.code_search_index_status?

optional code_search_index_status: object

Description

The status of the code search index for this repository

base.repo.code_search_index_status.lexical_search_ok?

optional lexical_search_ok: boolean

base.repo.code_search_index_status.lexical_commit_sha?

optional lexical_commit_sha: string

base.sha

sha: string

base.user

user: object

base.user.name?

optional name: string | null

base.user.email?

optional email: string | null

base.user.login

login: string

Example

octocat

base.user.id

id: number

Format: int64

Example

1

base.user.node_id

node_id: string

Example

MDQ6VXNlcjE=

base.user.avatar_url

avatar_url: string

Format: uri

Example

https://github.com/images/error/octocat_happy.gif

base.user.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

base.user.url

url: string

Format: uri

Example

https://api.github.com/users/octocat

base.user.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

base.user.followers_url

followers_url: string

Format: uri

Example

https://api.github.com/users/octocat/followers

base.user.following_url

following_url: string

Example

https://api.github.com/users/octocat/following{/other_user}

base.user.gists_url

gists_url: string

Example

https://api.github.com/users/octocat/gists{/gist_id}

base.user.starred_url

starred_url: string

Example

https://api.github.com/users/octocat/starred{/owner}{/repo}

base.user.subscriptions_url

subscriptions_url: string

Format: uri

Example

https://api.github.com/users/octocat/subscriptions

base.user.organizations_url

organizations_url: string

Format: uri

Example

https://api.github.com/users/octocat/orgs

base.user.repos_url

repos_url: string

Format: uri

Example

https://api.github.com/users/octocat/repos

base.user.events_url

events_url: string

Example

https://api.github.com/users/octocat/events{/privacy}

base.user.received_events_url

received_events_url: string

Format: uri

Example

https://api.github.com/users/octocat/received_events

base.user.type

type: string

Example

User

base.user.site_admin

site_admin: boolean

base.user.starred_at?

optional starred_at: string

Example

"2020-07-09T00:17:55Z"

base.user.user_view_type?

optional user_view_type: string

Example

public

_links

_links: object

_links.comments

comments: object

_links.comments.href

href: string

_links.commits

commits: object

_links.commits.href

href: string

_links.statuses

statuses: object

_links.statuses.href

href: string

_links.html

html: object

_links.html.href

href: string

_links.issue

issue: object

_links.issue.href

href: string

_links.review_comments

review_comments: object

_links.review_comments.href

href: string

_links.review_comment

review_comment: object

_links.review_comment.href

href: string

_links.self

self: object

_links.self.href

href: string

author_association

author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"

auto_merge

auto_merge: { enabled_by: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; }; merge_method: "merge" | "squash" | "rebase"; commit_title: string; commit_message: string; } | null

Type Declaration

{ enabled_by: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; }; merge_method: "merge" | "squash" | "rebase"; commit_title: string; commit_message: string; }

null

draft?

optional draft: boolean

Description

Indicates whether or not the pull request is a draft.

Example

false

merged

merged: boolean

mergeable

mergeable: boolean | null

Example

true

rebaseable?

optional rebaseable: boolean | null

Example

true

mergeable_state

mergeable_state: string

Example

clean

merged_by

merged_by: { name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; } | null

Type Declaration

{ name?: string | null; email?: string | null; login: string; id: number; node_id: string; avatar_url: string; gravatar_id: string | null; url: string; html_url: string; followers_url: string; following_url: string; gists_url: string; starred_url: string; subscriptions_url: string; organizations_url: string; repos_url: string; events_url: string; received_events_url: string; type: string; site_admin: boolean; starred_at?: string; user_view_type?: string; }

null

comments

comments: number

Example

10

review_comments

review_comments: number

Example

0

maintainer_can_modify

maintainer_can_modify: boolean

Description

Indicates whether maintainers can modify the pull request.

Example

true

commits

commits: number

Example

3

additions

additions: number

Example

100

deletions

deletions: number

Example

3

changed_files

changed_files: number

Example

5

---

number

number: number

---

type

type: "pull_request"