Skip to content

Commit 4aa1251

Browse files
feat: teams.getMembershipForUserInOrg, teams.addOrUpdateMembershipForUserInOrg, teams.removeMembershipForUserInOrg, teams.addOrUpdateProjectPermissionsInOrg, teams.checkPermissionsForProjectInOrg, teams.checkPermissionsForRepoInOrg, teams.addOrUpdateRepoPermissionsInOrg, issues.checkUserCanBeAssigned, migrations.getImportStatus, issues/list-milestones. Deprecation of previous method names
Co-authored-by: Octokit Bot <[email protected]>
1 parent 39f49db commit 4aa1251

File tree

66 files changed

+2343
-558
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+2343
-558
lines changed

docs/git/getRef.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single reference
2+
name: Get a reference
33
example: octokit.git.getRef({ owner, repo, ref })
44
route: GET /repos/{owner}/{repo}/git/ref/{ref}
55
scope: git
66
type: API method
77
---
88

9-
# Get a single reference
9+
# Get a reference
1010

1111
Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/<branch name>` for branches and `tags/<tag name>` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.
1212

@@ -45,4 +45,4 @@ octokit.git.getRef({
4545
</tbody>
4646
</table>
4747

48-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/git/refs/#get-a-single-reference).
48+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/git/refs/#get-a-reference).

docs/git/getTree.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
Returns a single tree using the SHA1 value for that tree.
1212

13-
If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.
13+
If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.
1414

1515
```js
1616
octokit.git.getTree({
@@ -33,22 +33,16 @@ octokit.git.getTree({
3333
<tbody>
3434
<tr><td>owner</td><td>yes</td><td>
3535

36-
owner parameter
37-
3836
</td></tr>
3937
<tr><td>repo</td><td>yes</td><td>
4038

41-
repo parameter
42-
4339
</td></tr>
4440
<tr><td>tree_sha</td><td>yes</td><td>
4541

46-
tree_sha parameter
47-
4842
</td></tr>
4943
<tr><td>recursive</td><td>no</td><td>
5044

51-
recursive parameter
45+
Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees.
5246

5347
</td></tr>
5448
</tbody>

docs/issues/checkAssignee.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
name: Check assignee
2+
name: Check if a user can be assigned
33
example: octokit.issues.checkAssignee({ owner, repo, assignee })
44
route: GET /repos/{owner}/{repo}/assignees/{assignee}
55
scope: issues
66
type: API method
77
---
88

9-
# Check assignee
9+
# Check if a user can be assigned
10+
11+
**Deprecated:** This method has been renamed to issues.checkUserCanBeAssigned
1012

1113
Checks if a user has permission to be assigned to an issue in this repository.
1214

@@ -45,4 +47,4 @@ octokit.issues.checkAssignee({
4547
</tbody>
4648
</table>
4749

48-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/assignees/#check-assignee).
50+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/assignees/#check-if-a-user-can-be-assigned).
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Check if a user can be assigned
3+
example: octokit.issues.checkUserCanBeAssigned({ owner, repo, assignee })
4+
route: GET /repos/{owner}/{repo}/assignees/{assignee}
5+
scope: issues
6+
type: API method
7+
---
8+
9+
# Check if a user can be assigned
10+
11+
Checks if a user has permission to be assigned to an issue in this repository.
12+
13+
If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.
14+
15+
Otherwise a `404` status code is returned.
16+
17+
```js
18+
octokit.issues.checkUserCanBeAssigned({
19+
owner,
20+
repo,
21+
assignee,
22+
});
23+
```
24+
25+
## Parameters
26+
27+
<table>
28+
<thead>
29+
<tr>
30+
<th>name</th>
31+
<th>required</th>
32+
<th>description</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr><td>owner</td><td>yes</td><td>
37+
38+
</td></tr>
39+
<tr><td>repo</td><td>yes</td><td>
40+
41+
</td></tr>
42+
<tr><td>assignee</td><td>yes</td><td>
43+
44+
</td></tr>
45+
</tbody>
46+
</table>
47+
48+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/assignees/#check-if-a-user-can-be-assigned).

docs/issues/createComment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Create a comment
2+
name: Create an issue comment
33
example: octokit.issues.createComment({ owner, repo, issue_number, body })
44
route: POST /repos/{owner}/{repo}/issues/{issue_number}/comments
55
scope: issues
66
type: API method
77
---
88

9-
# Create a comment
9+
# Create an issue comment
1010

1111
This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details.
1212

@@ -47,4 +47,4 @@ The contents of the comment.
4747
</tbody>
4848
</table>
4949

50-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#create-a-comment).
50+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#create-an-issue-comment).

docs/issues/deleteComment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Delete a comment
2+
name: Delete an issue comment
33
example: octokit.issues.deleteComment({ owner, repo, comment_id })
44
route: DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}
55
scope: issues
66
type: API method
77
---
88

9-
# Delete a comment
9+
# Delete an issue comment
1010

1111
```js
1212
octokit.issues.deleteComment({
@@ -39,4 +39,4 @@ octokit.issues.deleteComment({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#delete-a-comment).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#delete-an-issue-comment).

docs/issues/getComment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single comment
2+
name: Get an issue comment
33
example: octokit.issues.getComment({ owner, repo, comment_id })
44
route: GET /repos/{owner}/{repo}/issues/comments/{comment_id}
55
scope: issues
66
type: API method
77
---
88

9-
# Get a single comment
9+
# Get an issue comment
1010

1111
```js
1212
octokit.issues.getComment({
@@ -39,4 +39,4 @@ octokit.issues.getComment({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#get-a-single-comment).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/comments/#get-an-issue-comment).

docs/issues/getEvent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single event
2+
name: Get an issue event
33
example: octokit.issues.getEvent({ owner, repo, event_id })
44
route: GET /repos/{owner}/{repo}/issues/events/{event_id}
55
scope: issues
66
type: API method
77
---
88

9-
# Get a single event
9+
# Get an issue event
1010

1111
```js
1212
octokit.issues.getEvent({
@@ -39,4 +39,4 @@ octokit.issues.getEvent({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/events/#get-a-single-event).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/events/#get-an-issue-event).

docs/issues/getLabel.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single label
2+
name: Get a label
33
example: octokit.issues.getLabel({ owner, repo, name })
44
route: GET /repos/{owner}/{repo}/labels/{name}
55
scope: issues
66
type: API method
77
---
88

9-
# Get a single label
9+
# Get a label
1010

1111
```js
1212
octokit.issues.getLabel({
@@ -39,4 +39,4 @@ octokit.issues.getLabel({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/labels/#get-a-single-label).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/labels/#get-a-label).

docs/issues/getMilestone.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single milestone
2+
name: Get a milestone
33
example: octokit.issues.getMilestone({ owner, repo, milestone_number })
44
route: GET /repos/{owner}/{repo}/milestones/{milestone_number}
55
scope: issues
66
type: API method
77
---
88

9-
# Get a single milestone
9+
# Get a milestone
1010

1111
```js
1212
octokit.issues.getMilestone({
@@ -39,4 +39,4 @@ octokit.issues.getMilestone({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/milestones/#get-a-single-milestone).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/issues/milestones/#get-a-milestone).

0 commit comments

Comments
 (0)