RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.github.com/en/rest/gists/comments below:

REST API endpoints for gist comments

Use the REST API to view and modify comments on a gist.

You can use the REST API to view and modify comments on a gist. For more information about gists, see Editing and sharing content with gists.

Lists the comments on a gist.

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

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

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

gist_id string Required

The unique identifier of the gist.

Status code Description 200

304

Not modified

403

Forbidden

404

Resource not found

Request example

get/gists/{gist_id}/comments

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/gists/GIST_ID/comments

Response

Status: 200

[ { "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "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 }, "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.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

gist_id string Required

The unique identifier of the gist.

Body parameters Name, Type, Description

body string Required

The comment text.

Status code Description 201

Created

304

Not modified

403

Forbidden

404

Resource not found

Request example

post/gists/{gist_id}/comments

Copy to clipboard curl request example

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/gists/GIST_ID/comments \ -d '{"body":"This is a comment to a gist"}'

Response

Status: 201

{ "id": 1, "node_id": "MDExOkdpc3RDb21tZW50MQ==", "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1", "body": "Just commenting for the sake of commenting", "user": { "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 }, "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.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
application/vnd.github.base64+json: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.

This endpoint works with the following fine-grained token types:

The fine-grained token does not require any permissions.

Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

gist_id string Required

The unique identifier of the gist.

comment_id integer Required

The unique identifier of the comment.

Status code Description 200

304

Not modified

403

Forbidden Gist

404

Resource not found

Request example

get/gists/{gist_id}/comments/{comment_id}

Copy to clipboard curl request example

curl -L \ -H "Accept: application/vnd.github+json" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/gists/GIST_ID/comments/COMMENT_ID

Response

Status: 200

Updates a comment on a gist.

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

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

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

gist_id string Required

The unique identifier of the gist.

comment_id integer Required

The unique identifier of the comment.

Body parameters Name, Type, Description

body string Required

The comment text.

Status code Description 200

404

Resource not found

Request example

patch/gists/{gist_id}/comments/{comment_id}

Copy to clipboard curl request example

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/gists/GIST_ID/comments/COMMENT_ID \ -d '{"body":"This is an update to a comment in a gist"}'

Response

Status: 200

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Gists" user permissions (write)

Headers Name, Type, Description

accept string

Setting to application/vnd.github+json is recommended.

Path parameters Name, Type, Description

gist_id string Required

The unique identifier of the gist.

comment_id integer Required

The unique identifier of the comment.

Status code Description 204

No Content

304

Not modified

403

Forbidden

404

Resource not found

Request example

delete/gists/{gist_id}/comments/{comment_id}

Copy to clipboard curl request example

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/gists/GIST_ID/comments/COMMENT_ID

Response

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4