8000 try to clarify the difference between pull request comments and revie… · bguthrie/developer.github.com@03a158a · GitHub
[go: up one dir, main page]
Skip to content

Commit 03a158a

Browse files
technoweenietechnoweenie
committed
try to clarify the difference between pull request comments and review comments
1 parent 63502d1 commit 03a158a

File tree

3 files changed

+33
-3
lines changed

3 files changed

+33
-3
lines changed

‎content/v3/pulls.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@ Pull Requests leverage [these](#custom-mime-types) custom mime types. You
88
can read more about the use of mime types in the API
99
[here](/v3/mime/).
1010

11+
## Link Relations
12+
13+
Pull Requests have these possible link relations:
14+
15+
`self`
16+
: The API location of this Pull Request.
17+
18+
`html`
19+
: The HTML location of this Pull Request.
20+
21+
`comments`
22+
: The API location of this Pull Request's Issue comments.
23+
24+
`review_comments`
25+
: The API location of this Pull Request's Review comments.
26+
1127
## List pull requests
1228

1329
GET /repos/:user/:repo/pulls

‎content/v3/pulls/comments.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22
title: Pull Request Comments | GitHub API
33
---
44

5-
# Pull Request Comments API
5+
# Pull Request Review Comments API
66

7-
Pull Request Comments leverage [these](#custom-mime-types) custom mime
7+
Pull Request Review Comments are comments on a portion of the unified
8+
diff. These are separate from Commit Comments (which are applied
9+
directly to a commit, outside of the Pull Request view), and Issue
10+
Comments (which do not reference a portion of the unified diff).
11+
12+
Pull Request Review Comments leverage [these](#custom-mime-types) custom mime
813
types. You can read more about the use of mime types in the API
914
[here](/v3/mime/).
1015

‎lib/resources.rb‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,6 @@ def json(key)
150150
}
151151
}
152152

153-
154153
PULL = {
155154
"url" => "https://api.github.com/octocat/Hello-World/pulls/1",
156155
"html_url" => "https://github.com/octocat/Hello-World/pulls/1",
@@ -165,6 +164,16 @@ def json(key)
165164
"updated_at" => "2011-01-26T19:01:12Z",
166165
"closed_at" => "2011-01-26T19:01:12Z",
167166
"merged_at" => "2011-01-26T19:01:12Z",
167+
"_links" => {
168+
"self" => {'_href' =>
169+
"https://api.github.com/octocat/Hello-World/pulls/1"},
170+
"html" => {'_href' =>
171+
"https://github.com/octocat/Hello-World/pull/1"},
172+
"comments" => {'_href' =>
173+
"https://api.github.com/octocat/Hello-World/issues/1/comments"},
174+
"review_comments" => {'_href' =>
175+
"https://api.github.com/octocat/Hello-World/pulls/1/comments"}
176+
}
168177
}
169178

170179
FULL_PULL = PULL.merge({

0 commit comments

Comments
 (0)
0