comments
Overview
| Name | comments |
| Type | Resource |
| Id | github.issues.comments |
Fields
| Name | Datatype | Description |
|---|---|---|
id | integer | Unique identifier of the issue comment |
body | string | Contents of the issue comment |
reactions | object | |
url | string | URL for the issue comment |
created_at | string | |
author_association | string | How the author is associated with the repository. |
node_id | string | |
body_text | string | |
body_html | string | |
performed_via_github_app | object | GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. |
html_url | string | |
user | object | A GitHub user. |
issue_url | string | |
updated_at | string |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get_comment | SELECT | comment_id, owner, repo | You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. |
list_comments | SELECT | issue_number, owner, repo | You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. |
list_comments_for_repo | SELECT | owner, repo | You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. |
create_comment | INSERT | issue_number, owner, repo, data__body | You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details. |
delete_comment | DELETE | comment_id, owner, repo | You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. |
update_comment | EXEC | comment_id, owner, repo, data__body | You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. |