GitHub v3 REST API

Pull Request Review Request

object

Pull Request Review Request

usersarray[object]required

Simple User

Show Child Parameters
teamsarray[object]required

Groups of organization members that gives permissions on specified repositories.

Show Child Parameters
Example

Pull Request Review

object

Pull Request Reviews are reviews on pull requests.

idintegerrequired

Unique identifier of the review

Example:42

node_idstringrequired

Example:MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=

userobjectrequired

Simple User

Show Child Parameters
bodystringrequired

The text of the review.

Example:This looks great.

statestringrequired

Example:CHANGES_REQUESTED

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80

pull_request_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/12

_linksobjectrequired
Show Child Parameters
submitted_atstring(date-time)
commit_idstringrequired

A commit SHA for the review.

Example:54bb654c9e6025347f57900a4a5c2313a96b8035

body_htmlstring
body_textstring
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

Example

Legacy Review Comment

object

Legacy Review Comment

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/comments/1

pull_request_review_idintegerrequired

Example:42

idintegerrequired

Example:10

node_idstringrequired

Example:MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw

diff_hunkstringrequired

Example:@@ -16,33 +16,40 @@ public class Connection : IConnection...

pathstringrequired

Example:file1.txt

positionintegerrequired

Example:1

original_positionintegerrequired

Example:4

commit_idstringrequired

Example:6dcb09b5b57875f334f61aebed695e2e4193db5e

original_commit_idstringrequired

Example:9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840

in_reply_to_idinteger

Example:8

userobjectrequired

Simple User

Show Child Parameters
bodystringrequired

Example:Great stuff

created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

html_urlstring(uri)required

Example:https://github.com/octocat/Hello-World/pull/1#discussion-diff-1

pull_request_urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/pulls/1

author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

_linksobjectrequired
Show Child Parameters
body_textstring
body_htmlstring
reactionsobject
Show Child Parameters
sidestring

The side of the first line of the range for a multi-line comment.

Allowed values:LEFTRIGHT

Default:RIGHT

start_sidestring

The side of the first line of the range for a multi-line comment.

Allowed values:LEFTRIGHT

Default:RIGHT

lineinteger

The line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example:2

original_lineinteger

The original line of the blob to which the comment applies. The last line of the range for a multi-line comment

Example:2

start_lineinteger

The first line of the range for a multi-line comment.

Example:2

original_start_lineinteger

The original first line of the range for a multi-line comment.

Example:2

Example

Release Asset

object

Data related to a release.

urlstring(uri)required
browser_download_urlstring(uri)required
idintegerrequired
node_idstringrequired
namestringrequired

The file name of the asset.

Example:Team Environment

labelstringrequired
statestringrequired

State of the release asset.

Allowed values:uploadedopen

content_typestringrequired
sizeintegerrequired
download_countintegerrequired
created_atstring(date-time)required
updated_atstring(date-time)required
uploaderobjectrequired

Simple User

Show Child Parameters
Example

Release

object

A release.

urlstring(uri)required
html_urlstring(uri)required
assets_urlstring(uri)required
upload_urlstringrequired
tarball_urlstring(uri)required
zipball_urlstring(uri)required
idintegerrequired
node_idstringrequired
tag_namestringrequired

The name of the tag.

Example:v1.0.0

target_commitishstringrequired

Specifies the commitish value that determines where the Git tag is created from.

Example:master

namestringrequired
bodystring
draftbooleanrequired

true to create a draft (unpublished) release, false to create a published one.

prereleasebooleanrequired

Whether to identify the release as a prerelease or a full release.

created_atstring(date-time)required
published_atstring(date-time)required
authorobjectrequired

Simple User

Show Child Parameters
assetsarray[object]required

Data related to a release.

Show Child Parameters
body_htmlstring
body_textstring
reactionsobject
Show Child Parameters
Example