Skip to content

Commit bf089f4

Browse files
authored
feat: repos.getAccessRestrictions, pulls.listCommentsForReview, pulls.removeRequestedReviewers, pulls.requestReviewers, pulls.listRequestedReviewers, pulls.createReplyForReviewComment, pulls.createReviewComment, pulls.listReviewComments, pulls.deleteReviewComment, pulls.updateReviewComment, pulls.getReviewComment, pulls.listReviewCommentsForRepo, projects.getPermissionForUser, orgs.listPublicEmailsForAuthenticatedUser, orgs.updateMembershipForAuthenticatedUser, orgs.listMembershipsForAuthenticatedUser, users.deletePublicSshKeyForAuthenticated, users.getPublicSshKeyForAuthenticated, users.createPublicSshKeyForAuthenticated, users.listPublicSshKeysForAuthenticated, users.deleteGpgKeyForAuthenticated, users.getGpgKeyForAuthenticated, users.createGpgKeyForAuthenticated, users.listGpgKeysForAuthenticated, users.checkPersonIsFollowedByAuthenticated, users.deleteEmailsForAuthenticated, users.addEmailsForAuthenticated, users.listEmailsForAuthenticated, users.setPrimaryEmailVisibilityForAuthenticated, users.listBlockedByAuthenticated, scim.deleteUserFromOrg, scim.updateAttributeForUser, scim.setInformationForProvisionedUser, scim.getProvisioningInformationForUser, scim.provisionAndInviteUser, repos.downloadArchive, repos.createCommitStatus, repos.listReleaseAssets, repos.requestPagesBuild, repos.deletePagesSite, repos.createPagesSite, repos.deleteDeployKey, repos.createDeployKey, testPushWebhook, pingWebhook, deleteWebhook, updateWebhook, getWebhook, createWebhook, listWebhooks, repos.createOrUpdateFileContents, repos.getContent, repos.getCommunityProfileMetrics, repos.listCommitStatusesForRef, repos.listCommitComments, repos.removeUserAccessRestrictions, repos.addUserAccessRestrictions, repos.setUserAccessRestrictions, repos.removeTeamAccessRestrictions, repos.addTeamAccessRestrictions, repos.setTeamAccessRestrictions, repos.removeAppAccessRestrictions, repos.addAppAccessRestrictions, repos.setAppAccessRestrictions, repos.removeProtectedBranchRestrictions, repos.removeStatusCheckContexts, repos.addStatusCheckContexts, repos.setStatusCheckContexts, repos.getAllStatusCheckContexts, repos.removeStatusChecksProtection, repos.updateStatusChecksProtection, repos.getStatusChecksProtection, repos.deleteCommitSignatureProtection, repos.createCommitSignatureProtection, repos.getCommitSignatureProtection, repos.deletePullRequestReviewProtection, repos.updatePullRequestReviewProtection, repos.getPullRequestReviewProtection, repos.deleteAdminBranchProtection, repos.setAdminBranchProtection, repos.getAdminBranchProtection, repos.deleteBranchProtection, orgs.removePublicMembershipForAuthenticatedUser, orgs.setPublicMembershipForAuthenticatedUser, orgs.checkPublicMembershipForUser, orgs.removeMembershipForUser, orgs.setMembershipForUser, orgs.getMembershipForUser, orgs.checkMembershipForUser, orgs.listAppInstallations, orgs.pingHook, orgs.deleteHook, orgs.updateHook, orgs.getHook, orgs.createHook, orgs.listHooks, orgs.removeCredentialAuthorization, orgs.listSamlSsoAuthorizations, repos.listCommitCommentsForRepo. (#132)
Deprecates `repos.getProtectedBranchRestrictions`, `pulls.getCommentsForReview`, `pulls.deleteReviewRequest`, `pulls.createReviewRequest`, `pulls.listReviewRequests`, `pulls.createReviewCommentReply`, `pulls.createComment`, `pulls.listComments`, `pulls.deleteComment`, `pulls.updateComment`, `pulls.getComment`, `pulls.listCommentsForRepo`, `projects.reviewUserPermissionLevel`, `orgs.listPublicEmails`, `orgs.updateMembership`, `orgs.listMemberships`, `users.deletePublicKey`, `users.getPublicKey`, `users.createPublicKey`, `users.listPublicKeys`, `users.deleteGpgKey`, `users.getGpgKey`, `users.createGpgKey`, `users.listGpgKeys`, `users.checkFollowing`, `users.deleteEmailsForAuthenticated`, `users.addEmailsForAuthenticated`, `users.listEmailsForAuthenticated`, `users.togglePrimaryEmailVisibility`, `users.listBlocked`, `scim.removeUserFromOrg`, `scim.updateUserAttribute`, `scim.replaceProvisionedUserInformation`, `scim.getProvisioningDetailsForUser`, `scim.provisionAndInviteUsers`, `repos.getArchiveLink`, `repos.createStatus`, `repos.listAssetsForRelease`, `repos.requestPageBuild`, `repos.disbalePagesSite`, `repos.enablePagesSite`, `repos.removeDeployKey`, `repos.addDeployKey`, `testPushHook`, `pingHook`, `deleteHook`, `updateHook`, `getHook`, `createHook`, `listHooks`, `repos.createOrUpdateFile`, `repos.getContents`, `repos.retrieveCommunityProfileMetrics`, `repos.listStatusesForRef`, `repos.listCommentsForCommit`, `repos.removeProtectedBranchUserRestrictions`, `repos.addProtectedBranchUserRestrictions`, `repos.replaceProtectedBranchUserRestrictions`, `repos.removeProtectedBranchTeamRestrictions`, `repos.addProtectedBranchTeamRestrictions`, `repos.replaceProtectedBranchTeamRestrictions`, `repos.removeProtectedBranchAppRestrictions`, `repos.addProtectedBranchAppRestrictions`, `repos.replaceProtectedBranchAppRestrictions`, `repos.deleteAccessRestrictions`, `repos.removeProtectedBranchRequiredStatusChecksContexts`, `repos.addProtectedBranchRequiredStatusChecksContexts`, `repos.replaceProtectedBranchRequiredStatusChecksContexts`, `repos.listProtectedBranchRequiredStatusChecksContexts`, `repos.removeProtectedBranchRequiredStatusChecks`, `repos.updateProtectedBranchRequiredStatusChecks`, `repos.getProtectedBranchRequiredStatusChecks`, `repos.removeProtectedBranchRequiredSignatures`, `repos.addProtectedBranchRequiredSignatures`, `repos.getProtectedBranchRequiredSignatures`, `repos.removeProtectedBranchPullRequestReviewEnforcement`, `repos.updateProtectedBranchPullRequestReviewEnforcement`, `repos.getProtectedBranchPullRequestReviewEnforcement`, `repos.removeProtectedBranchAdminEnforcement`, `repos.addProtectedBranchAdminEnforcement`, `repos.getProtectedBranchAdminEnforcement`, `repos.removeBranchProtection`, `orgs.concealMembership`, `orgs.publicizeMembership`, `orgs.checkPublicMembership`, `orgs.removeMembership`, `orgs.addOrUpdateMembership`, `orgs.getMembership`, `orgs.checkMembership`, `orgs.listInstallations`, `orgs.pingWebhook`, `orgs.deleteWebhook`, `orgs.updateWebhook`, `orgs.getWebhook`, `orgs.createWebhook`, `orgs.listWebhooks`, `orgs.removeSamlSsoAuthorization`, `orgs.listCredentialAuthorizations`, `repos.listCommitComments`.
1 parent 1a95a47 commit bf089f4

File tree

273 files changed

+21700
-7143
lines changed

Some content is hidden

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

273 files changed

+21700
-7143
lines changed

docs/git/getRef.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
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

13-
**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)".
13+
**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)".
1414

1515
To get the reference for a branch named `skunkworkz/featureA`, the endpoint route is:
1616

docs/git/listMatchingRefs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Returns an array of references from your Git database that match the supplied na
1212

1313
When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.
1414

15-
**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)".
15+
**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)".
1616

1717
If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.
1818

docs/licenses/getForRepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ type: API method
1010

1111
This method returns the contents of the repository's license file, if one is detected.
1212

13-
Similar to [the repository contents API](https://developer.github.com/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.
13+
Similar to [Get repository content](https://developer.github.com/v3/repos/contents/#get-repository-content), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.
1414

1515
```js
1616
octokit.licenses.getForRepo({

docs/orgs/addOrUpdateMembership.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
---
2-
name: Add or update organization membership
2+
name: Set organization membership for a user
33
example: octokit.orgs.addOrUpdateMembership({ org, username })
44
route: PUT /orgs/{org}/memberships/{username}
55
scope: orgs
66
type: API method
77
---
88

9-
# Add or update organization membership
9+
# Set organization membership for a user
10+
11+
**Deprecated:** This method has been renamed to orgs.setMembershipForUser
1012

1113
Only authenticated organization owners can add a member to the organization or update the member's role.
1214

13-
- If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be `pending` until they accept the invitation.
15+
- If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.
1416

1517
- Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.
1618

@@ -52,4 +54,4 @@ The role to give the user in the organization. Can be one of:
5254
</tbody>
5355
</table>
5456

55-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership).
57+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#set-organization-membership-for-a-user).

docs/orgs/blockUser.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Block a user
2+
name: Block a user from an organization
33
example: octokit.orgs.blockUser({ org, username })
44
route: PUT /orgs/{org}/blocks/{username}
55
scope: orgs
66
type: API method
77
---
88

9-
# Block a user
9+
# Block a user from an organization
1010

1111
```js
1212
octokit.orgs.blockUser({
@@ -35,4 +35,4 @@ octokit.orgs.blockUser({
3535
</tbody>
3636
</table>
3737

38-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#block-a-user).
38+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#block-a-user-from-an-organization).

docs/orgs/checkBlockedUser.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Check whether a user is blocked from an organization
2+
name: Check if a user is blocked by an organization
33
example: octokit.orgs.checkBlockedUser({ org, username })
44
route: GET /orgs/{org}/blocks/{username}
55
scope: orgs
66
type: API method
77
---
88

9-
# Check whether a user is blocked from an organization
9+
# Check if a user is blocked by an organization
1010

1111
If the user is blocked:
1212

@@ -39,4 +39,4 @@ octokit.orgs.checkBlockedUser({
3939
</tbody>
4040
</table>
4141

42-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#check-if-a-user-is-blocked-by-an-organization).

docs/orgs/checkMembership.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
name: Check membership
2+
name: Check organization membership for a user
33
example: octokit.orgs.checkMembership({ org, username })
44
route: GET /orgs/{org}/members/{username}
55
scope: orgs
66
type: API method
77
---
88

9-
# Check membership
9+
# Check organization membership for a user
10+
11+
**Deprecated:** This method has been renamed to orgs.checkMembershipForUser
1012

1113
Check if a user is, publicly or privately, a member of the organization.
1214

@@ -37,4 +39,4 @@ octokit.orgs.checkMembership({
3739
</tbody>
3840
</table>
3941

40-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-membership).
42+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-organization-membership-for-a-user).
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Check organization membership for a user
3+
example: octokit.orgs.checkMembershipForUser({ org, username })
4+
route: GET /orgs/{org}/members/{username}
5+
scope: orgs
6+
type: API method
7+
---
8+
9+
# Check organization membership for a user
10+
11+
Check if a user is, publicly or privately, a member of the organization.
12+
13+
```js
14+
octokit.orgs.checkMembershipForUser({
15+
org,
16+
username,
17+
});
18+
```
19+
20+
## Parameters
21+
22+
<table>
23+
<thead>
24+
<tr>
25+
<th>name</th>
26+
<th>required</th>
27+
<th>description</th>
28+
</tr>
29+
</thead>
30+
<tbody>
31+
<tr><td>org</td><td>yes</td><td>
32+
33+
</td></tr>
34+
<tr><td>username</td><td>yes</td><td>
35+
36+
</td></tr>
37+
</tbody>
38+
</table>
39+
40+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-organization-membership-for-a-user).

docs/orgs/checkPublicMembership.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
name: Check public membership
2+
name: Check public organization membership for a user
33
example: octokit.orgs.checkPublicMembership({ org, username })
44
route: GET /orgs/{org}/public_members/{username}
55
scope: orgs
66
type: API method
77
---
88

9-
# Check public membership
9+
# Check public organization membership for a user
10+
11+
**Deprecated:** This method has been renamed to orgs.checkPublicMembershipForUser
1012

1113
```js
1214
octokit.orgs.checkPublicMembership({
@@ -35,4 +37,4 @@ octokit.orgs.checkPublicMembership({
3537
</tbody>
3638
</table>
3739

38-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-membership).
40+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-organization-membership-for-a-user).
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Check public organization membership for a user
3+
example: octokit.orgs.checkPublicMembershipForUser({ org, username })
4+
route: GET /orgs/{org}/public_members/{username}
5+
scope: orgs
6+
type: API method
7+
---
8+
9+
# Check public organization membership for a user
10+
11+
```js
12+
octokit.orgs.checkPublicMembershipForUser({
13+
org,
14+
username,
15+
});
16+
```
17+
18+
## Parameters
19+
20+
<table>
21+
<thead>
22+
<tr>
23+
<th>name</th>
24+
<th>required</th>
25+
<th>description</th>
26+
</tr>
27+
</thead>
28+
<tbody>
29+
<tr><td>org</td><td>yes</td><td>
30+
31+
</td></tr>
32+
<tr><td>username</td><td>yes</td><td>
33+
34+
</td></tr>
35+
</tbody>
36+
</table>
37+
38+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-organization-membership-for-a-user).

0 commit comments

Comments
 (0)