Skip to main content

issue_comment_pins

Creates, updates, deletes, gets or lists an issue_comment_pins resource.

Overview

Nameissue_comment_pins
TypeResource
Idgithub.issues.issue_comment_pins

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
pin_commentreplaceowner, repo, comment_idYou can use the REST API to pin comments on issues.

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

- application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
- application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
- application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
- application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
unpin_commentdeleteowner, repo, comment_idYou can use the REST API to unpin comments on issues.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
comment_idinteger (int64)The unique identifier of the comment.
ownerstringThe account owner of the repository. The name is not case sensitive.
repostringThe name of the repository without the .git extension. The name is not case sensitive.

REPLACE examples

You can use the REST API to pin comments on issues.

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

- application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
- application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
- application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
- application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

REPLACE github.issues.issue_comment_pins
SET
-- No updatable properties
WHERE
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND comment_id = '{{ comment_id }}' --required
RETURNING
id,
node_id,
author_association,
body,
body_html,
body_text,
created_at,
html_url,
issue_url,
performed_via_github_app,
pin,
reactions,
updated_at,
url,
user;

DELETE examples

You can use the REST API to unpin comments on issues.

DELETE FROM github.issues.issue_comment_pins
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND comment_id = '{{ comment_id }}' --required
;