Skip to content

Commit 96b1be1

Browse files
committed
Document new batch comments methods
1 parent 30705a0 commit 96b1be1

3 files changed

Lines changed: 46 additions & 1 deletion

File tree

content/v3/issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ direction
9292
: `asc` or `desc`, default: `desc`.
9393

9494
since
95-
: _Optional_ **string** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
95+
: _Optional_ **String** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
9696

9797
### Response
9898

content/v3/issues/comments.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,28 @@ You can read more about the use of mime types in the API
2323
<%= headers 200, :pagination => true %>
2424
<%= json(:issue_comment) { |h| [h] } %>
2525

26+
## List comments in a repository
27+
28+
GET /repos/:owner/:repo/issues/comments
29+
30+
By default, Issue Comments are ordered by ascending ID.
31+
32+
### Parameters
33+
34+
sort
35+
: _Optional_ **String** `created` or `updated`
36+
37+
direction
38+
: _Optional_ **String** `asc` or `desc`. Ignored without `sort` parameter.
39+
40+
since
41+
: _Optional_ **String** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
42+
43+
### Response
44+
45+
<%= headers 200 %>
46+
<%= json(:pull_comment) { |h| [h] } %>
47+
2648
## Get a single comment
2749

2850
GET /repos/:owner/:repo/issues/comments/:id

content/v3/pulls/comments.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,28 @@ types. You can read more about the use of mime types in the API
2525
<%= headers 200 %>
2626
<%= json(:pull_comment) { |h| [h] } %>
2727

28+
## List comments in a repository
29+
30+
GET /repos/:owner/:repo/pulls/comments
31+
32+
By default, Review Comments are ordered by ascending ID.
33+
34+
### Parameters
35+
36+
sort
37+
: _Optional_ **String** `created` or `updated`
38+
39+
direction
40+
: _Optional_ **String** `asc` or `desc`. Ignored without `sort` parameter.
41+
42+
since
43+
: _Optional_ **String** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
44+
45+
### Response
46+
47+
<%= headers 200 %>
48+
<%= json(:pull_comment) { |h| [h] } %>
49+
2850
## Get a single comment
2951

3052
GET /repos/:owner/:repo/pulls/comments/:number
@@ -123,3 +145,4 @@ more about the use of mime types in the API [here](/v3/media/).
123145
application/vnd.github.VERSION.text+json
124146
application/vnd.github.VERSION.html+json
125147
application/vnd.github.VERSION.full+json
148+

0 commit comments

Comments
 (0)