IssueEntity

A resolved issue entity from GitHub.

Properties

data

data: object

id

id: number

Format: int64

node_id

node_id: string

url

url: string

Format: uri

Description

URL for the issue

Example

https://api.github.com/repositories/42/issues/1

repository_url

repository_url: string

Format: uri

labels_url

labels_url: string

comments_url

comments_url: string

Format: uri

events_url

events_url: string

Format: uri

html_url

html_url: string

Format: uri

number

number: number

Description

Number uniquely identifying the issue within its repository

Example

state

state: string

Description

State of the issue; either ‘open’ or ‘closed’

Example

open

state_reason?

optional state_reason: "completed" | "reopened" | "not_planned" | null

Description

The reason for the current state

Example

not_planned
@enum {string|null}

title

title: string

Description

Title of the issue

Example

Widget creation fails in Safari on OS X 10.8

body?

optional body: string | null

Description

Contents of the issue

Example

It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?

user

user: { 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

labels

labels: (string | { id?: number; node_id?: string; url?: string; name?: string; description?: string | null; color?: string | null; default?: boolean; })[]

Description

Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository

Example

[
  "bug",
  "registration"
]

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

null

assignees?

optional assignees: object[] | null

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

locked

locked: boolean

active_lock_reason?

optional active_lock_reason: string | null

comments

comments: number

pull_request?

optional pull_request: object

pull_request.merged_at?

optional merged_at: string | null

Format: date-time

pull_request.diff_url

diff_url: string | null

Format: uri

pull_request.html_url

html_url: string | null

Format: uri

pull_request.patch_url

patch_url: string | null

Format: uri

pull_request.url

url: string | null

Format: uri

closed_at

closed_at: string | null

Format: date-time

created_at

created_at: string

Format: date-time

updated_at

updated_at: string

Format: date-time

draft?

optional draft: boolean

closed_by?

optional closed_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

null

body_html?

optional body_html: string

body_text?

optional body_text: string

timeline_url?

optional timeline_url: string

Format: uri

type?

optional type: { id: number; node_id: string; name: string; description: string | null; color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; created_at?: string; updated_at?: string; is_enabled?: boolean; } | null

Type Declaration

{ id: number; node_id: string; name: string; description: string | null; color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; created_at?: string; updated_at?: string; is_enabled?: boolean; }

null

repository?

optional repository: object

repository.id

id: number

Format: int64

Description

Unique identifier of the repository

Example

repository.node_id

node_id: string

Example

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

repository.name

name: string

Description

The name of the repository.

Example

Team Environment

repository.full_name

full_name: string

Example

octocat/Hello-World

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

repository.forks

forks: number

repository.permissions?

optional permissions: object

repository.permissions.admin

admin: boolean

repository.permissions.pull

pull: boolean

repository.permissions.triage?

optional triage: boolean

repository.permissions.push

push: boolean

repository.permissions.maintain?

optional maintain: boolean

repository.owner

owner: object

repository.owner.name?

optional name: string | null

repository.owner.email?

optional email: string | null

repository.owner.login

login: string

Example

octocat

repository.owner.id

id: number

Format: int64

Example

repository.owner.node_id

node_id: string

Example

MDQ6VXNlcjE=

repository.owner.avatar_url

avatar_url: string

Format: uri

Example

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

repository.owner.gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

repository.owner.url

url: string

Format: uri

Example

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

repository.owner.html_url

html_url: string

Format: uri

Example

https://github.com/octocat

repository.owner.followers_url

followers_url: string

Format: uri

Example

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

repository.owner.following_url

following_url: string

Example

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

repository.owner.gists_url

gists_url: string

Example

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

repository.owner.starred_url

starred_url: string

Example

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

repository.owner.subscriptions_url

subscriptions_url: string

Format: uri

Example

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

repository.owner.organizations_url

organizations_url: string

Format: uri

Example

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

repository.owner.repos_url

repos_url: string

Format: uri

Example

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

repository.owner.events_url

events_url: string

Example

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

repository.owner.received_events_url

received_events_url: string

Format: uri

Example

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

repository.owner.type

type: string

Example

User

repository.owner.site_admin

site_admin: boolean

repository.owner.starred_at?

optional starred_at: string

Example

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

repository.owner.user_view_type?

optional user_view_type: string

Example

public

repository.private

private: boolean

Description

Whether the repository is private or public.

Default

false

repository.html_url

html_url: string

Format: uri

Example

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

repository.description

description: string | null

Example

This your first repo!

repository.fork

fork: boolean

repository.url

url: string

Format: uri

Example

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

repository.archive_url

archive_url: string

Example

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

repository.assignees_url

assignees_url: string

Example

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

repository.blobs_url

blobs_url: string

Example

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

repository.branches_url

branches_url: string

Example

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

repository.collaborators_url

collaborators_url: string

Example

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

repository.comments_url

comments_url: string

Example

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

repository.commits_url

commits_url: string

Example

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

repository.compare_url

compare_url: string

Example

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

repository.contents_url

contents_url: string

Example

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

repository.contributors_url

contributors_url: string

Format: uri

Example

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

repository.deployments_url

deployments_url: string

Format: uri

Example

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

repository.downloads_url

downloads_url: string

Format: uri

Example

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

repository.events_url

events_url: string

Format: uri

Example

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

repository.forks_url

forks_url: string

Format: uri

Example

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

repository.git_commits_url

git_commits_url: string

Example

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

repository.git_refs_url

git_refs_url: string

Example

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

repository.git_tags_url

git_tags_url: string

Example

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

repository.git_url

git_url: string

Example

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

repository.issue_comment_url

issue_comment_url: string

Example

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

repository.issue_events_url

issue_events_url: string

Example

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

repository.issues_url

issues_url: string

Example

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

repository.keys_url

keys_url: string

Example

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

repository.labels_url

labels_url: string

Example

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

repository.languages_url

languages_url: string

Format: uri

Example

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

repository.merges_url

merges_url: string

Format: uri

Example

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

repository.milestones_url

milestones_url: string

Example

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

repository.notifications_url

notifications_url: string

Example

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

repository.pulls_url

pulls_url: string

Example

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

repository.releases_url

releases_url: string

Example

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

repository.ssh_url

ssh_url: string

Example

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

repository.stargazers_url

stargazers_url: string

Format: uri

Example

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

repository.statuses_url

statuses_url: string

Example

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

repository.subscribers_url

subscribers_url: string

Format: uri

Example

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

repository.subscription_url

subscription_url: string

Format: uri

Example

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

repository.tags_url

tags_url: string

Format: uri

Example

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

repository.teams_url

teams_url: string

Format: uri

Example

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

repository.trees_url

trees_url: string

Example

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

repository.clone_url

clone_url: string

Example

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

repository.mirror_url

mirror_url: string | null

Format: uri

Example

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

repository.hooks_url

hooks_url: string

Format: uri

Example

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

repository.svn_url

svn_url: string

Format: uri

Example

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

repository.homepage

homepage: string | null

Format: uri

Example

https://github.com

repository.language

language: string | null

repository.forks_count

forks_count: number

Example

repository.stargazers_count

stargazers_count: number

Example

repository.watchers_count

watchers_count: number

Example

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

repository.default_branch

default_branch: string

Description

The default branch of the repository.

Example

master

repository.open_issues_count

open_issues_count: number

Example

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

repository.topics?

optional topics: string[]

repository.has_issues

has_issues: boolean

Description

Whether issues are enabled.

Default

true

Example

true

repository.has_projects

has_projects: boolean

Description

Whether projects are enabled.

Default

true

Example

true

repository.has_wiki

has_wiki: boolean

Description

Whether the wiki is enabled.

Default

true

Example

true

repository.has_pages

has_pages: boolean

repository.has_downloads

has_downloads: boolean

Description

Whether downloads are enabled.

Default

true

Example

true

repository.has_discussions?

optional has_discussions: boolean

Description

Whether discussions are enabled.

Default

false

Example

true

repository.archived

archived: boolean

Description

Whether the repository is archived.

Default

false

repository.disabled

disabled: boolean

Description

Returns whether or not this repository disabled.

repository.visibility?

optional visibility: string

Description

The repository visibility: public, private, or internal.

Default

public

repository.pushed_at

pushed_at: string | null

Format: date-time

Example

2011-01-26T19:06:43Z

repository.created_at

created_at: string | null

Format: date-time

Example

2011-01-26T19:01:12Z

repository.updated_at

updated_at: string | null

Format: date-time

Example

2011-01-26T19:14:43Z

repository.allow_rebase_merge?

optional allow_rebase_merge: boolean

Description

Whether to allow rebase merges for pull requests.

Default

true

Example

true

repository.temp_clone_token?

optional temp_clone_token: string

repository.allow_squash_merge?

optional allow_squash_merge: boolean

Description

Whether to allow squash merges for pull requests.

Default

true

Example

true

repository.allow_auto_merge?

optional allow_auto_merge: boolean

Description

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

Default

false

Example

false

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

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

repository.use_squash_pr_title_as_default?

optional use_squash_pr_title_as_default: boolean

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

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

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

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

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

repository.allow_merge_commit?

optional allow_merge_commit: boolean

Description

Whether to allow merge commits for pull requests.

Default

true

Example

true

repository.allow_forking?

optional allow_forking: boolean

Description

Whether to allow forking this repo

repository.web_commit_signoff_required?

optional web_commit_signoff_required: boolean

Description

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

Default

false

repository.open_issues

open_issues: number

repository.watchers

watchers: number

repository.master_branch?

optional master_branch: string

repository.starred_at?

optional starred_at: string

Example

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

repository.anonymous_access_enabled?

optional anonymous_access_enabled: boolean

Description

Whether anonymous git access is enabled for this repository

repository.code_search_index_status?

optional code_search_index_status: object

Description

The status of the code search index for this repository

repository.code_search_index_status.lexical_search_ok?

optional lexical_search_ok: boolean

repository.code_search_index_status.lexical_commit_sha?

optional lexical_commit_sha: string

performed_via_github_app?

optional performed_via_github_app: { id: number; slug?: string; node_id: string; client_id?: string; owner: { 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; } | { description?: string | null; html_url: string; website_url?: string | null; id: number; node_id: string; name: string; slug: string; created_at: string | null; updated_at: string | null; avatar_url: string; }; name: string; description: string | null; external_url: string; html_url: string; created_at: string; updated_at: string; permissions: {[key: string]: string | undefined; issues?: string; checks?: string; metadata?: string; contents?: string; deployments?: string; }; events: string[]; installations_count?: number; client_secret?: string; webhook_secret?: string | null; pem?: string; } | null

Type Declaration

{ id: number; slug?: string; node_id: string; client_id?: string; owner: { 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; } | { description?: string | null; html_url: string; website_url?: string | null; id: number; node_id: string; name: string; slug: string; created_at: string | null; updated_at: string | null; avatar_url: string; }; name: string; description: string | null; external_url: string; html_url: string; created_at: string; updated_at: string; permissions: {[key: string]: string | undefined; issues?: string; checks?: string; metadata?: string; contents?: string; deployments?: string; }; events: string[]; installations_count?: number; client_secret?: string; webhook_secret?: string | null; pem?: string; }

null

author_association

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

reactions?

optional reactions: object

reactions.url

url: string

Format: uri

reactions.total_count

total_count: number

reactions.+1

+1: number

reactions.-1

-1: number

reactions.laugh

laugh: number

reactions.confused

confused: number

reactions.heart

heart: number

reactions.hooray

hooray: number

reactions.eyes

eyes: number

reactions.rocket

rocket: number

sub_issues_summary?

optional sub_issues_summary: object

sub_issues_summary.total

total: number

sub_issues_summary.completed

completed: number

sub_issues_summary.percent_completed

percent_completed: number

number

number: number

type

type: "issue"