Back to GithubGet a discussion comment
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
Input
type: object
properties:
parameters:
type: object
properties:
org:
type: string
description: The organization name. The name is not case sensitive.
team_slug:
type: string
description: The slug of the team name.
discussion_number:
type: integer
description: The number that identifies the discussion.
comment_number:
type: integer
description: The number that identifies the comment.
required:
- org
- team_slug
- discussion_number
- comment_number
title: Parameters
Output
type: object
title: Team Discussion Comment
properties:
author:
type: object
title: Simple User
properties:
name:
nullable: true
type: string
email:
nullable: true
type: string
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
body:
description: The main text of the comment.
example: I agree with this suggestion.
type: string
body_html:
type: string
example: <p>Do you like apples?</p>
body_version:
description: >-
The current version of the body content. If provided, this update
operation will be rejected if the given version does not match the latest
version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
created_at:
type: string
format: date-time
example: '2018-01-15T23:53:58.000Z'
last_edited_at:
type: string
format: date-time
nullable: true
discussion_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2403582/discussions/1
html_url:
type: string
format: uri
example: >-
https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
node_id:
type: string
example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
number:
description: The unique sequence number of a team discussion comment.
example: 42
type: integer
updated_at:
type: string
format: date-time
example: '2018-01-15T23:53:58.000Z'
url:
type: string
format: uri
example: >-
https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
reactions:
type: object
title: Reaction Rollup
properties:
url:
type: string
format: uri
total_count:
type: integer
'+1':
type: integer
'-1':
type: integer
laugh:
type: integer
confused:
type: integer
heart:
type: integer
hooray:
type: integer
eyes:
type: integer
rocket:
type: integer