Esta versión de GitHub Enterprise se discontinuó el 2022-06-03. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener un mejor desempeño, más seguridad y nuevas características, actualiza a la última versión de GitHub Enterprise. Para obtener ayuda con la actualización, contacta al soporte de GitHub Enterprise.
Team discussion comments
The team discussion comments API allows you to get, create, edit, and delete discussion comments on a team discussion post.
About the Team discussion comments API
Cualquier miembro de la organización del equipo puede crear y leer los comentarios de un debate público. Para obtener más detalles, consulta la sección "Acerca de los debates de equipo".
Esta API solo está disponible para los miembros autenticados de la organization del equipo. Los tokens de acceso de OAuth requieren el alcance read:org
. GitHub genera el slug
del equipo a partir del name
del mismo.
List discussion comments
List all comments 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
.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
team_slug stringRequeridoThe slug of the team name. |
discussion_number integerRequeridoThe number that identifies the discussion. |
Parámetros de consulta |
Nombre, Tipo, Descripción |
direction stringThe direction to sort the results by. Predeterminado: Puede ser una de las siguientes: |
per_page integerThe number of results per page (max 100). Predeterminado: |
page integerPage number of the results to fetch. Predeterminado: |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
]
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Create a discussion comment
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
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
.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
team_slug stringRequeridoThe slug of the team name. |
discussion_number integerRequeridoThe number that identifies the discussion. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
body stringRequeridoThe discussion comment's body text. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
201 | Created |
Ejemplos de código
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Get 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}
.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
team_slug stringRequeridoThe slug of the team name. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Update a discussion comment
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion
scope.
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}
.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
team_slug stringRequeridoThe slug of the team name. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
body stringRequeridoThe discussion comment's body text. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-X PATCH \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Delete a discussion comment
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion
scope.
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}
.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
org stringRequeridoThe organization name. The name is not case sensitive. |
team_slug stringRequeridoThe slug of the team name. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
204 | No Content |
Ejemplos de código
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/orgs/ORG/teams/TEAM_SLUG/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 204
List discussion comments (Legacy)
Deprecation Notice: This endpoint route is deprecated 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 access tokens require the read:discussion
scope.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
team_id integerRequeridoThe unique identifier of the team. |
discussion_number integerRequeridoThe number that identifies the discussion. |
Parámetros de consulta |
Nombre, Tipo, Descripción |
direction stringThe direction to sort the results by. Predeterminado: Puede ser una de las siguientes: |
per_page integerThe number of results per page (max 100). Predeterminado: |
page integerPage number of the results to fetch. Predeterminado: |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
]
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Create a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated 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. OAuth access tokens require the write:discussion
scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
team_id integerRequeridoThe unique identifier of the team. |
discussion_number integerRequeridoThe number that identifies the discussion. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
body stringRequeridoThe discussion comment's body text. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
201 | Created |
Ejemplos de código
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Get a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated 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 access tokens require the read:discussion
scope.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
team_id integerRequeridoThe unique identifier of the team. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Update a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated 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 access tokens require the write:discussion
scope.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
team_id integerRequeridoThe unique identifier of the team. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Parámetros de cuerpo |
Nombre, Tipo, Descripción |
body stringRequeridoThe discussion comment's body text. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
200 | OK |
Ejemplos de código
curl \
-X PATCH \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}
}
Aviso de previsualización
An additional reactions
object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.
To access the API you must provide a custom media type in the Accept
header:
application/vnd.github.squirrel-girl-preview
The reactions
key will have the following payload where url
can be used to construct the API location for listing and creating reactions.
Delete a discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated 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 access tokens require the write:discussion
scope.
Parámetros
Encabezados |
---|
Nombre, Tipo, Descripción |
accept stringSetting to |
Parámetros de ruta |
Nombre, Tipo, Descripción |
team_id integerRequeridoThe unique identifier of the team. |
discussion_number integerRequeridoThe number that identifies the discussion. |
comment_number integerRequeridoThe number that identifies the comment. |
Códigos de estado de respuesta HTTP
Código de estado | Descripción |
---|---|
204 | No Content |
Ejemplos de código
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token <TOKEN>" \
http(s)://HOSTNAME/api/v3/teams/TEAM_ID/discussions/DISCUSSION_NUMBER/comments/COMMENT_NUMBER
Response
Status: 204