Skip to main content

comments

Overview

Namecomments
TypeResource
Idgithub.repos.comments

Fields

NameDatatypeDescription
idinteger
author_associationstringHow the author is associated with the repository.
bodystring
commit_idstring
created_atstring
html_urlstring
lineinteger
node_idstring
pathstring
positioninteger
reactionsobject
updated_atstring
urlstring
userobjectA GitHub user.

Methods

NameAccessible byRequired ParamsDescription
get_commit_commentSELECTcomment_id, owner, repo
list_comments_for_commitSELECTcommit_sha, owner, repoUse the :commit_sha to specify the commit that will have its comments listed.
list_commit_comments_for_repoSELECTowner, repoCommit Comments use these custom media types. You can read more about the use of media types in the API here.

Comments are ordered by ascending ID.
create_commit_commentINSERTcommit_sha, owner, repo, data__bodyCreate a comment for a commit using its :commit_sha.

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_commit_commentDELETEcomment_id, owner, repo
update_commit_commentEXECcomment_id, owner, repo, data__body