CommentEntity
A resolved comment entity from GitHub. Can be a comment on an issue, pull request, or discussion.
Properties
Section titled “Properties”commentId
Section titled “commentId”commentId:
number
data:
object
id:
number
Format: int64
Description
Section titled “Description”Unique identifier of the issue comment
Example
Section titled “Example”42node_id
Section titled “node_id”node_id:
string
url:
string
Format: uri
Description
Section titled “Description”URL for the issue comment
Example
Section titled “Example”https://api.github.com/repositories/42/issues/comments/1
optionalbody:string
Description
Section titled “Description”Contents of the issue comment
Example
Section titled “Example”What version of Safari were you using when you observed this bug?body_text?
Section titled “body_text?”
optionalbody_text:string
body_html?
Section titled “body_html?”
optionalbody_html:string
html_url
Section titled “html_url”html_url:
string
Format: uri
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
Section titled “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
created_at
Section titled “created_at”created_at:
string
Format: date-time
Example
Section titled “Example”2011-04-14T16:00:49Zupdated_at
Section titled “updated_at”updated_at:
string
Format: date-time
Example
Section titled “Example”2011-04-14T16:00:49Zissue_url
Section titled “issue_url”issue_url:
string
Format: uri
author_association
Section titled “author_association”author_association:
"COLLABORATOR"|"CONTRIBUTOR"|"FIRST_TIMER"|"FIRST_TIME_CONTRIBUTOR"|"MANNEQUIN"|"MEMBER"|"NONE"|"OWNER"
performed_via_github_app?
Section titled “performed_via_github_app?”
optionalperformed_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
Section titled “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
reactions?
Section titled “reactions?”
optionalreactions:object
reactions.url
Section titled “reactions.url”url:
string
Format: uri
reactions.total_count
Section titled “reactions.total_count”total_count:
number
reactions.+1
Section titled “reactions.+1”+1:
number
reactions.-1
Section titled “reactions.-1”-1:
number
reactions.laugh
Section titled “reactions.laugh”laugh:
number
reactions.confused
Section titled “reactions.confused”confused:
number
reactions.heart
Section titled “reactions.heart”heart:
number
reactions.hooray
Section titled “reactions.hooray”hooray:
number
reactions.eyes
Section titled “reactions.eyes”eyes:
number
reactions.rocket
Section titled “reactions.rocket”rocket:
number
parentNumber
Section titled “parentNumber”parentNumber:
number
parentType
Section titled “parentType”parentType:
"discussion"|"issue"|"pull_request"
type:
"comment"