用于团队讨论备注的 REST API 终结点
使用 REST API 获取、创建、编辑和删除团队讨论帖子上的评论。
团队讨论和团队讨论备注终结点已于 2023 年 11 月 28 日 弃用,改为 GitHub Discussions。 有关 GitHub Discussions 的详细信息,请参阅“GitHub Discussions 文档”。
List discussion comments
List all comments on a team discussion.
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
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
“List discussion comments”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
team_slug string 必须The slug of the team name. |
discussion_number integer 必须The number that identifies the discussion. |
名称, 类型, 说明 |
---|
direction string The direction to sort the results by. 默认: 可以是以下选项之一: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
“List discussion comments”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“List discussion comments”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments
Response
Status: 200
[
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
]
Create a discussion comment
Creates a new comment on a team discussion.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
Note
You can also specify a team by org_id
and team_id
using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Create a discussion comment”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
team_slug string 必须The slug of the team name. |
discussion_number integer 必须The number that identifies the discussion. |
名称, 类型, 说明 |
---|
body string 必须The discussion comment's body text. |
“Create a discussion comment”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
201 | Created |
“Create a discussion comment”的示例代码
请求示例
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments \
-d '{"body":"Do you like apples?"}'
Response
Status: 201
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Get a discussion comment
Get a specific comment on a team discussion.
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}
.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
“Get a discussion comment”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
team_slug string 必须The slug of the team name. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
“Get a discussion comment”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“Get a discussion comment”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 200
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Update a discussion comment
Edits the body text of a discussion comment.
Note
You can also specify a team by org_id
and team_id
using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Update a discussion comment”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
team_slug string 必须The slug of the team name. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
名称, 类型, 说明 |
---|
body string 必须The discussion comment's body text. |
“Update a discussion comment”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“Update a discussion comment”的示例代码
请求示例
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER \
-d '{"body":"Do you like pineapples?"}'
Response
Status: 200
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like pineapples?",
"body_html": "<p>Do you like pineapples?</p>",
"body_version": "e6907b24d9c93cc0c5024a7af5888116",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-26T18:22:20Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Delete a discussion comment
Deletes a comment on a team discussion.
Note
You can also specify a team by org_id
and team_id
using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}
.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Delete a discussion comment”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
org string 必须The organization name. The name is not case sensitive. |
team_slug string 必须The slug of the team name. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
“Delete a discussion comment”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
204 | No Content |
“Delete a discussion comment”的示例代码
请求示例
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 204
List discussion comments (Legacy)
Warning
Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List discussion comments endpoint.
List all comments on a team discussion.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
“List discussion comments (Legacy)”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
team_id integer 必须The unique identifier of the team. |
discussion_number integer 必须The number that identifies the discussion. |
名称, 类型, 说明 |
---|
direction string The direction to sort the results by. 默认: 可以是以下选项之一: |
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 默认: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 默认: |
“List discussion comments (Legacy)”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“List discussion comments (Legacy)”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments
Response
Status: 200
[
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
]
Create a discussion comment (Legacy)
Warning
Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Create a discussion comment endpoint.
Creates a new comment on a team discussion.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API."
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Create a discussion comment (Legacy)”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
team_id integer 必须The unique identifier of the team. |
discussion_number integer 必须The number that identifies the discussion. |
名称, 类型, 说明 |
---|
body string 必须The discussion comment's body text. |
“Create a discussion comment (Legacy)”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
201 | Created |
“Create a discussion comment (Legacy)”的示例代码
请求示例
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments \
-d '{"body":"Do you like apples?"}'
Response
Status: 201
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Get a discussion comment (Legacy)
Warning
Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Get a discussion comment endpoint.
Get a specific comment on a team discussion.
OAuth app tokens and personal access tokens (classic) need the read:discussion
scope to use this endpoint.
“Get a discussion comment (Legacy)”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
team_id integer 必须The unique identifier of the team. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
“Get a discussion comment (Legacy)”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“Get a discussion comment (Legacy)”的示例代码
请求示例
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 200
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like apples?",
"body_html": "<p>Do you like apples?</p>",
"body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": null,
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-15T23:53:58Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Update a discussion comment (Legacy)
Warning
Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Update a discussion comment endpoint.
Edits the body text of a discussion comment.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Update a discussion comment (Legacy)”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
team_id integer 必须The unique identifier of the team. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
名称, 类型, 说明 |
---|
body string 必须The discussion comment's body text. |
“Update a discussion comment (Legacy)”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
200 | OK |
“Update a discussion comment (Legacy)”的示例代码
请求示例
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER \
-d '{"body":"Do you like pineapples?"}'
Response
Status: 200
{
"author": {
"login": "octocat",
"id": 1,
"node_id": "MDQ6VXNlcjE=",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"gravatar_id": "",
"url": "https://api.github.com/users/octocat",
"html_url": "https://github.com/octocat",
"followers_url": "https://api.github.com/users/octocat/followers",
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
"organizations_url": "https://api.github.com/users/octocat/orgs",
"repos_url": "https://api.github.com/users/octocat/repos",
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
"received_events_url": "https://api.github.com/users/octocat/received_events",
"type": "User",
"site_admin": false
},
"body": "Do you like pineapples?",
"body_html": "<p>Do you like pineapples?</p>",
"body_version": "e6907b24d9c93cc0c5024a7af5888116",
"created_at": "2018-01-15T23:53:58Z",
"last_edited_at": "2018-01-26T18:22:20Z",
"discussion_url": "https://api.github.com/teams/2403582/discussions/1",
"html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1",
"node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=",
"number": 1,
"updated_at": "2018-01-26T18:22:20Z",
"url": "https://api.github.com/teams/2403582/discussions/1/comments/1",
"reactions": {
"url": "https://api.github.com/teams/2403582/discussions/1/reactions",
"total_count": 5,
"+1": 3,
"-1": 1,
"laugh": 0,
"confused": 0,
"heart": 1,
"hooray": 0,
"eyes": 1,
"rocket": 1
}
}
Delete a discussion comment (Legacy)
Warning
Endpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion comment endpoint.
Deletes a comment on a team discussion.
OAuth app tokens and personal access tokens (classic) need the write:discussion
scope to use this endpoint.
“Delete a discussion comment (Legacy)”的参数
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
team_id integer 必须The unique identifier of the team. |
discussion_number integer 必须The number that identifies the discussion. |
comment_number integer 必须The number that identifies the comment. |
“Delete a discussion comment (Legacy)”的 HTTP 响应状态代码
状态代码 | 说明 |
---|---|
204 | No Content |
“Delete a discussion comment (Legacy)”的示例代码
请求示例
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 204