PullRequestComments
Records comments on pull requests, documenting feedback and discussions during the code review process.
View-Specific Information
Select
The add-in uses the GitHub API to process WHERE clause conditions that are built with the following column and operators:
- PullRequestId supports the '=,IN' comparison operators.
For example, the following queries are processed server-side:
SELECT * FROM [PullRequestComments]
SELECT * FROM [PullRequestComments] WHERE [PullRequestId] = 'Val1'
The add-in processes other filters client-side within the add-in.
Columns
Name | Type | References | OrderBySupport | Description |
Id [KEY] | String | Represents a unique identifier for the comment, allowing the comment to be distinctly referenced or tracked within the system. | ||
Body | String | Contains the main content of the comment written in Markdown format, allowing for rich text, links, images, and other Markdown-supported elements. | ||
BodyText | String | Contains the content of the comment rendered as plain text. This version strips away any formatting and is useful for simple text parsing or processing. | ||
BodyHTML | String | Contains the content of the comment rendered as HTML, allowing for formatted text with applied styles, links, and other HTML elements. | ||
Author | String | Specifies the username of the person who originally authored the comment. This identifies the contributor or reviewer who posted the comment. | ||
AuthorAssociation | String | Describes the relationship between the author and the subject of the comment. Possible values include 'OWNER', 'COLLABORATOR', or 'CONTRIBUTOR', indicating the role of the author in relation to the repository. | ||
Editor | String | Indicates the username of the person who last edited the comment. If the comment has been edited after its original post, this field shows the editor’s username. | ||
IsMinimized | Bool | Indicates whether the comment has been minimized for any reason. A value of 'true' means the comment is minimized and is not fully visible to users by default. | ||
MinimizedReason | String | Provides the reason why the comment was minimized, if applicable. This can be due to content moderation or other factors like spam or inappropriate content. | ||
CreatedViaEmail | Bool | Indicates whether the comment was created via an email reply to a GitHub notification. A value of 'true' means the comment originated from email communication. | ||
IncludesCreatedEdit | Bool | Indicates whether the comment includes an edit that was made at the time of creation. This field is useful for tracking whether the comment was edited right after it was created. | ||
ResourcePath | String | Specifies the relative HTTP path to access this comment via the GitHub API. This allows for API interactions and programmatically retrieving the comment. | ||
Url | String | Provides the full HTTP URL to access this comment directly on GitHub. This URL can be used to view the comment in a browser or to link directly to the comment. | ||
LastEditedAt | Datetime | Represents the date and time when the comment was last edited. If the comment has been edited, this timestamp shows when the most recent change occurred. | ||
PublishedAt | Datetime | Represents the date and time when the comment was originally published. This timestamp is recorded when the comment was first posted, before any potential edits. | ||
CreatedAt | Datetime | Specifies the date and time when the comment was initially created. This is the moment the comment was first added to the thread or pull request. | ||
UpdatedAt | Datetime | Represents the date and time when the comment was last updated, including any edits or changes to the comment’s content. | ||
ViewerDidAuthor | Bool | Indicates whether the current viewer is the author of the comment. A value of 'true' means the viewer is the person who posted the comment. | ||
ViewerCanDelete | Bool | Indicates whether the current viewer has permission to delete this comment. A value of 'true' means the viewer can remove the comment from the thread. | ||
ViewerCanMinimize | Bool | Indicates whether the current viewer has permission to minimize this comment. A value of 'true' means the viewer can collapse the comment to reduce its visibility. | ||
ViewerCanReact | Bool | Indicates whether the viewer can react to the comment using emoji or other reactions. A value of 'true' means the viewer can add a reaction to the comment. | ||
ViewerCanUpdate | Bool | Indicates whether the current viewer has permission to update or edit this comment. A value of 'true' means the viewer is allowed to modify the comment. | ||
ViewerCannotUpdateReasons | String | A list of reasons why the current viewer cannot update this comment, if applicable. This can include restrictions like 'permission denied' or 'comment is locked'. | ||
IssueId | String | Represents the ID of the issue associated with the comment, if the comment was made on an issue. This links the comment to a specific issue within the repository. | ||
PullRequestId | String | Represents the ID of the pull request associated with the comment, if the comment was made on a pull request. This links the comment to a specific pull request being discussed or reviewed. | ||
FullDatabaseId | Long | Represents a unique identifier for the comment in the database, stored as a BigInt. This ID is used internally within GitHub to reference the comment in the database. |