Delete a gist comment | GitHub API (unofficial showcase)

2 parameters

gist_idstringrequired

The unique identifier of the gist containing the comment.

comment_idintegerrequired

The unique identifier of the comment to delete.

4 status codes

204Returns no content after the gist comment is deleted.

304Returned when the gist comment has not changed since the last request.

403Returned when the authenticated user is not permitted to delete the gist comment.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when the gist or comment does not exist.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when the authenticated user cannot delete the comment. A 404 is returned when the gist_id path parameter or comment_id path parameter does not identify an existing gist comment.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.comments.delete({
  gistId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  commentId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors