CommentEntity

A resolved comment entity from GitHub. Can be a comment on an issue, pull request, or discussion.

Properties

commentId

commentId: number

data

data: object

id

id: number

Format: int64

Description

Unique identifier of the issue comment

Example

node_id

node_id: string

url

url: string

Format: uri

Description

URL for the issue comment

Example

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

body?

optional body?: string

Description

Contents of the issue comment

Example

What version of Safari were you using when you observed this bug?

body_text?

optional body_text?: string

body_html?

optional body_html?: string

html_url

html_url: string

Format: uri

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

Union Members

Type Literal

{ 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; }

name?

optional name?: string | null

email?

optional email?: string | null

login: string

Example

octocat

id

id: number

Format: int64

Example

node_id

node_id: string

Example

MDQ6VXNlcjE=

avatar_url

avatar_url: string

Format: uri

Example

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

gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

url

url: string

Format: uri

Example

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

html_url

html_url: string

Format: uri

Example

https://github.com/octocat

followers_url

followers_url: string

Format: uri

Example

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

following_url

following_url: string

Example

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

gists_url

gists_url: string

Example

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

starred_url

starred_url: string

Example

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

subscriptions_url

subscriptions_url: string

Format: uri

Example

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

organizations_url

organizations_url: string

Format: uri

Example

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

repos_url

repos_url: string

Format: uri

Example

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

events_url

events_url: string

Example

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

received_events_url

received_events_url: string

Format: uri

Example

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

type

type: string

Example

User

site_admin

site_admin: boolean

starred_at?

optional starred_at?: string

Example

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

user_view_type?

optional user_view_type?: string

Example

public

null

created_at

created_at: string

Format: date-time

Example

2011-04-14T16:00:49Z

updated_at

updated_at: string

Format: date-time

Example

2011-04-14T16:00:49Z

issue_url

issue_url: string

Format: uri

author_association

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

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; } | null

Union Members

Type Literal

{ 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; }

id

id: number

Description

Unique identifier of the GitHub app

Example

slug?

optional slug?: string

Description

The slug name of the GitHub app

Example

probot-owners

node_id

node_id: string

Example

MDExOkludGVncmF0aW9uMQ==

client_id?

optional client_id?: string

Example

"Iv1.25b5d1e65ffc4022"

owner

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; }

Union Members

Type Literal

name?

optional name?: string | null

email?

optional email?: string | null

login: string

Example

octocat

id

id: number

Format: int64

Example

node_id

node_id: string

Example

MDQ6VXNlcjE=

avatar_url

avatar_url: string

Format: uri

Example

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

gravatar_id

gravatar_id: string | null

Example

41d064eb2195891e12d0413f63227ea7

url

url: string

Format: uri

Example

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

html_url

html_url: string

Format: uri

Example

https://github.com/octocat

followers_url

followers_url: string

Format: uri

Example

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

following_url

following_url: string

Example

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

gists_url

gists_url: string

Example

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

starred_url

starred_url: string

Example

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

subscriptions_url

subscriptions_url: string

Format: uri

Example

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

organizations_url

organizations_url: string

Format: uri

Example

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

repos_url

repos_url: string

Format: uri

Example

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

events_url

events_url: string

Example

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

received_events_url

received_events_url: string

Format: uri

Example

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

type

type: string

Example

User

site_admin

site_admin: boolean

starred_at?

optional starred_at?: string

Example

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

user_view_type?

optional user_view_type?: string

Example

public

Type Literal

{ 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; }

description?

optional description?: string | null

Description

A short description of the enterprise.

html_url

html_url: string

Format: uri

Example

https://github.com/enterprises/octo-business

website_url?

optional website_url?: string | null

Format: uri

Description

The enterprise’s website URL.

id

id: number

Description

Unique identifier of the enterprise

Example

node_id

node_id: string

Example

MDEwOlJlcG9zaXRvcnkxMjk2MjY5

name

name: string

Description

The name of the enterprise.

Example

Octo Business

slug

slug: string

Description

The slug url identifier for the enterprise.

Example

octo-business

created_at

created_at: string | null

Format: date-time

Example

2019-01-26T19:01:12Z

updated_at

updated_at: string | null

Format: date-time

Example

2019-01-26T19:14:43Z

avatar_url

avatar_url: string

Format: uri

name

name: string

Description

The name of the GitHub app

Example

Probot Owners

description

description: string | null

Example

The description of the app.

external_url

external_url: string

Format: uri

Example

https://example.com

html_url

html_url: string

Format: uri

Example

https://github.com/apps/super-ci

created_at

created_at: string

Format: date-time

Example

2017-07-08T16:18:44-04:00

updated_at

updated_at: string

Format: date-time

Example

2017-07-08T16:18:44-04:00

permissions

permissions: object

Index Signature

[key: string]: string | undefined

Description

The set of permissions for the GitHub app

Example

{
       *   "issues": "read",
       *   "deployments": "write"
       * }

permissions.issues?

optional issues?: string

permissions.checks?

optional checks?: string

permissions.metadata?

optional metadata?: string

permissions.contents?

optional contents?: string

permissions.deployments?

optional deployments?: string

events

events: string[]

Description

The list of events for the GitHub app. Note that the installation_target, security_advisory, and meta events are not included because they are global events and not specific to an installation.

Example

[
  "label",
  "deployment"
]

installations_count?

optional installations_count?: number

Description

The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.

Example

null

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

parentNumber

parentNumber: number

parentType

parentType: "discussion" | "issue" | "pull_request"

type

type: "comment"