Delete a commit comment | GitHub API (unofficial showcase)

3 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The repository name without the `.git` extension. The name is not case sensitive.

comment_idintegerrequired

The unique identifier of the commit comment to delete.

2 status codes

204Returns no response body and confirms that the commit comment was deleted.

404Returned when the repository or commit comment cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the repository or commit comment cannot be found. The owner and repo path parameters must identify the repository, and the comment_id path parameter must identify the comment to delete.

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

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

const result = await client.comments.delete({
  owner: "octocat",
  repo: "hello-world",
  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