Skip to content

Commit bdb36dc

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent 6fe5e9b commit bdb36dc

File tree

24 files changed

+62
-69
lines changed

24 files changed

+62
-69
lines changed

‎content/v3/activity/events.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ in the timeline is less than 300).
3737

3838
All Events have the same response format:
3939

40-
<%= headers 200, :pagination => { :next => 'https://api.github.com/resource?page=2' } %>
40+
<%= headers 200, :pagination => default_pagination_rels %>
4141
<%= json(:event) { |h| [h] } %>
4242

4343
## List public events

‎content/v3/gists.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ The keys in the `files` object are the `string` filename. The value is another `
190190

191191
### Response
192192

193-
<%= headers 200 %>
193+
<%= headers 200, :pagination => default_pagination_rels %>
194194
<%= json(:gist_forks) %>
195195

196196
## Delete a gist

‎content/v3/gists/comments.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can read more about the use of media types in the API
1717

1818
### Response
1919

20-
<%= headers 200 %>
20+
<%= headers 200, :pagination => default_pagination_rels %>
2121
<%= json(:gist_comment) { |h| [h] } %>
2222

2323
## Get a single comment
@@ -35,7 +35,7 @@ You can read more about the use of media types in the API
3535

3636
### Parameters
3737

38-
Name | Type | Description
38+
Name | Type | Description
3939
-----|------|--------------
4040
`body`|`string` | **Required**. The comment text.
4141

@@ -54,7 +54,7 @@ Name | Type | Description
5454

5555
### Input
5656

57-
Name | Type | Description
57+
Name | Type | Description
5858
-----|------|--------------
5959
`body`|`string` | **Required**. The comment text.
6060

‎content/v3/git/refs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ references, you can call:
3636

3737
For a full refs listing, you'll get something that looks like:
3838

39-
<%= headers 200 %>
39+
<%= headers 200, :pagination => default_pagination_rels %>
4040
<%= json :refs %>
4141

4242

‎content/v3/issues/assignees.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ issues may be assigned.
1616

1717
### Response
1818

19-
<%= headers 200 %>
19+
<%= headers 200, :pagination => default_pagination_rels %>
2020
<%= json(:user) { |h| [h] } %>
2121

2222
## Check assignee

‎content/v3/issues/comments.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ By default, Issue Comments are ordered by ascending ID.
3131

3232
### Parameters
3333

34-
Name | Type | Description
34+
Name | Type | Description
3535
-----|------|--------------
3636
`sort`|`string` | Either `created` or `updated`. Default: `created`
3737
`direction`|`string` | Either `asc` or `desc`. Ignored without the `sort` parameter.
@@ -49,7 +49,7 @@ Name | Type | Description
4949

5050
### Response
5151

52-
<%= headers 200 %>
52+
<%= headers 200, :pagination => default_pagination_rels %>
5353
<%= json :issue_comment %>
5454

5555
## Create a comment
@@ -78,7 +78,7 @@ Name | Type | Description
7878

7979
### Input
8080

81-
Name | Type | Description
81+
Name | Type | Description
8282
-----|------|--------------
8383
`body`|`string` | **Required**. The contents of the comment.
8484

‎content/v3/issues/labels.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ title: Issue Labels | GitHub API
1313

1414
### Response
1515

16-
<%= headers 200 %>
16+
<%= headers 200, :pagination => default_pagination_rels %>
1717
<%= json(:label) { |h| [h] } %>
1818

1919
## Get a single label
@@ -31,7 +31,7 @@ title: Issue Labels | GitHub API
3131

3232
### Parameters
3333

34-
Name | Type | Description
34+
Name | Type | Description
3535
-----|------|--------------
3636
`name`|`string` | **Required**. The name of the label.
3737
`color`|`string` |**Required**. A 6 character hex code, without the leading `#`, identifying the color.
@@ -52,7 +52,7 @@ Name | Type | Description
5252

5353
### Parameters
5454

55-
Name | Type | Description
55+
Name | Type | Description
5656
-----|------|--------------
5757
`name`|`string` | **Required**. The name of the label.
5858
`color`|`string` |**Required**. A 6 character hex code, without the leading `#`, identifying the color.
@@ -79,7 +79,7 @@ Name | Type | Description
7979

8080
### Response
8181

82-
<%= headers 200 %>
82+
<%= headers 200, :pagination => default_pagination_rels %>
8383
<%= json(:label) { |h| [h] } %>
8484

8585
## Add labels to an issue
@@ -132,5 +132,5 @@ Sending an empty array (`[]`) will remove all Labels from the Issue.
132132

133133
### Response
134134

135-
<%= headers 200 %>
135+
<%= headers 200, :pagination => default_pagination_rels %>
136136
<%= json(:label) { |h| [h] } %>

‎content/v3/orgs/members.md‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Name | Type | Description
2626

2727
### Response
2828

29-
<%= headers 200 %>
29+
<%= headers 200, :pagination => default_pagination_rels %>
3030
<%= json(:user) { |h| [h] } %>
3131

3232
### Response if requester is not an organization member
@@ -80,7 +80,7 @@ publicized or not.
8080

8181
### Response
8282

83-
<%= headers 200 %>
83+
<%= headers 200, :pagination => default_pagination_rels %>
8484
<%= json(:user) { |h| [h] } %>
8585

8686
## Check public membership
@@ -118,26 +118,18 @@ The user can publicize their own membership.
118118

119119
## List your organization memberships
120120

121-
An optional `state` can be passed to request only pending or active memberships.
122-
123121
GET /user/memberships/orgs
124-
GET /user/memberships/orgs?state=active
125-
GET /user/memberships/orgs?state=pending
126-
127-
### Response when no state is specified
128122

129-
<%= headers 200, :pagination => default_pagination_rels %>
130-
<%= json(:org_memberships) %>
131-
132-
### Response when a "pending" state is specified
123+
### Input
133124

134-
<%= headers 200, :pagination => default_pagination_rels %>
135-
<%= json(:pending_org_memberships) %>
125+
Name | Type | Description
126+
-----|------|--------------
127+
`state`|`string`| Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, both active and pending memberships are returned.
136128

137-
### Response when an "active" state is specified
129+
### Response
138130

139131
<%= headers 200, :pagination => default_pagination_rels %>
140-
<%= json(:active_org_memberships) %>
132+
<%= json(:org_memberships) %>
141133

142134
## Get your organization membership
143135

‎content/v3/orgs/teams.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ OAuth users require the "read:org" [scope](/v3/oauth/#scopes).
1717

1818
### Response
1919

20-
<%= headers 200 %>
20+
<%= headers 200, :pagination => default_pagination_rels %>
2121
<%= json(:team) { |h| [h] } %>
2222

2323
## Get team
@@ -101,7 +101,7 @@ member of the team.
101101

102102
### Response
103103

104-
<%= headers 200 %>
104+
<%= headers 200, :pagination => default_pagination_rels %>
105105
<%= json(:user) { |h| [h] } %>
106106

107107
## Get team member
@@ -296,7 +296,7 @@ team.
296296

297297
### Response
298298

299-
<%= headers 200 %>
299+
<%= headers 200, :pagination => default_pagination_rels %>
300300
<%= json(:repo) { |h| [h] } %>
301301

302302
## Check if a team manages a repository {#get-team-repo}
@@ -362,7 +362,7 @@ authenticated user belongs. This method requires `user` or `repo`
362362

363363
### Response
364364

365-
<%= headers 200 %>
365+
<%= headers 200, :pagination => default_pagination_rels %>
366366
<%= json(:full_team) { |h| [h] } %>
367367

368368
[OAuth]: /v3/oauth/

‎content/v3/pulls.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Name | Type | Description
4747

4848
### Response
4949

50-
<%= headers 200 %>
50+
<%= headers 200, :pagination => default_pagination_rels %>
5151
<%= json(:pull) { |h| [h] } %>
5252

5353
## Get a single pull request
@@ -149,7 +149,7 @@ Name | Type | Description
149149

150150
### Response
151151

152-
<%= headers 200 %>
152+
<%= headers 200, :pagination => default_pagination_rels %>
153153
<%= json(:commit) { |h| [h] } %>
154154

155155
Note: The response includes a maximum of 250 commits. If you are working with a pull request larger than that, you can use the [Commit List API](/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the pull request.
@@ -160,7 +160,7 @@ Note: The response includes a maximum of 250 commits. If you are working with a
160160

161161
### Response
162162

163-
<%= headers 200 %>
163+
<%= headers 200, :pagination => default_pagination_rels %>
164164
<%= json(:file) { |h| [h] } %>
165165

166166
## Get if a pull request has been merged

0 commit comments

Comments
 (0)