Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para comentarios de gist

Puedes usar la API REST para ver y modificar los comentarios en un gist. Para más información sobre gists, consulta Editar y compartir contenido con gists.

Lists the comments on a gist.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd..raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • application/vnd..base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Tokens de acceso específicos para "List gist comments"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Parámetros para "List gist comments"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
gist_id string Requerido

The unique identifier of the gist.

Parámetros de consulta
per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Valor predeterminado: 30

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Valor predeterminado: 1

Códigos de estado de respuesta HTTP para "List gist comments"

status codeDescripción
200

OK

304

Not modified

403

Forbidden

404

Resource not found

Ejemplos de código para "List gist comments"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/gists/{gist_id}/comments
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/gists/GIST_ID/comments

Response

Status: 200
[ { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api..com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" } ]

Creates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd..raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • application/vnd..base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Tokens de acceso específicos para "Create a gist comment"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Gists" user permissions (write)

Parámetros para "Create a gist comment"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
gist_id string Requerido

The unique identifier of the gist.

Parámetros del cuerpo
body string Requerido

The comment text.

Códigos de estado de respuesta HTTP para "Create a gist comment"

status codeDescripción
201

Created

304

Not modified

403

Forbidden

404

Resource not found

Ejemplos de código para "Create a gist comment"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

post/gists/{gist_id}/comments
curl -L \ -X POST \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/gists/GIST_ID/comments \ -d '{"body":"This is a comment to a gist"}'

Response

Status: 201
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api..com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Gets a comment on a gist.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd..raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • application/vnd..base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Tokens de acceso específicos para "Get a gist comment"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado no requiere ningún permiso.

Parámetros para "Get a gist comment"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
gist_id string Requerido

The unique identifier of the gist.

comment_id integer Requerido

The unique identifier of the comment.

Códigos de estado de respuesta HTTP para "Get a gist comment"

status codeDescripción
200

OK

304

Not modified

403

Forbidden Gist

404

Resource not found

Ejemplos de código para "Get a gist comment"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/gists/{gist_id}/comments/{comment_id}
curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/gists/GIST_ID/comments/COMMENT_ID

Response

Status: 200
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api..com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Updates a comment on a gist.

This endpoint supports the following custom media types. For more information, see "Media types."

  • application/vnd..raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • application/vnd..base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

Tokens de acceso específicos para "Update a gist comment"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Gists" user permissions (write)

Parámetros para "Update a gist comment"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
gist_id string Requerido

The unique identifier of the gist.

comment_id integer Requerido

The unique identifier of the comment.

Parámetros del cuerpo
body string Requerido

The comment text.

Códigos de estado de respuesta HTTP para "Update a gist comment"

status codeDescripción
200

OK

404

Resource not found

Ejemplos de código para "Update a gist comment"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

/gists/{gist_id}/comments/{comment_id}
curl -L \ -X \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/gists/GIST_ID/comments/COMMENT_ID \ -d '{"body":"This is an update to a comment in a gist"}'

Response

Status: 200
{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api..com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "created_at": "2011-04-18T23:23:56Z", "updated_at": "2011-04-18T23:23:56Z", "author_association": "COLLABORATOR" }

Tokens de acceso específicos para "Delete a gist comment"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

  • "Gists" user permissions (write)

Parámetros para "Delete a gist comment"

Encabezados
accept string

Setting to application/vnd.+json is recommended.

Parámetros de la ruta de acceso
gist_id string Requerido

The unique identifier of the gist.

comment_id integer Requerido

The unique identifier of the comment.

Códigos de estado de respuesta HTTP para "Delete a gist comment"

status codeDescripción
204

No Content

304

Not modified

403

Forbidden

404

Resource not found

Ejemplos de código para "Delete a gist comment"

Si accedes a en GHE.com, reemplaza api..com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/gists/{gist_id}/comments/{comment_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/gists/GIST_ID/comments/COMMENT_ID

Response

Status: 204