Skip to content

🎤 I got 99 problems, but a breaking change ain't one #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/git/getRef.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

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.

**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)".
**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)".

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

Expand Down
2 changes: 1 addition & 1 deletion docs/git/listMatchingRefs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Returns an array of references from your Git database that match the supplied na

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`.

**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)".
**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)".

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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/licenses/getForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

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

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.
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.

```js
octokit.licenses.getForRepo({
Expand Down
10 changes: 6 additions & 4 deletions docs/orgs/addOrUpdateMembership.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
name: Add or update organization membership
name: Set organization membership for a user
example: octokit.orgs.addOrUpdateMembership({ org, username })
route: PUT /orgs/{org}/memberships/{username}
scope: orgs
type: API method
---

# Add or update organization membership
# Set organization membership for a user

**Deprecated:** This method has been renamed to orgs.setMembershipForUser

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

- 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.
- 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.

- 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.

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

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#set-organization-membership-for-a-user).
6 changes: 3 additions & 3 deletions docs/orgs/blockUser.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Block a user
name: Block a user from an organization
example: octokit.orgs.blockUser({ org, username })
route: PUT /orgs/{org}/blocks/{username}
scope: orgs
type: API method
---

# Block a user
# Block a user from an organization

```js
octokit.orgs.blockUser({
Expand Down Expand Up @@ -35,4 +35,4 @@ octokit.orgs.blockUser({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#block-a-user).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#block-a-user-from-an-organization).
6 changes: 3 additions & 3 deletions docs/orgs/checkBlockedUser.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Check whether a user is blocked from an organization
name: Check if a user is blocked by an organization
example: octokit.orgs.checkBlockedUser({ org, username })
route: GET /orgs/{org}/blocks/{username}
scope: orgs
type: API method
---

# Check whether a user is blocked from an organization
# Check if a user is blocked by an organization

If the user is blocked:

Expand Down Expand Up @@ -39,4 +39,4 @@ octokit.orgs.checkBlockedUser({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/blocking/#check-if-a-user-is-blocked-by-an-organization).
8 changes: 5 additions & 3 deletions docs/orgs/checkMembership.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: Check membership
name: Check organization membership for a user
example: octokit.orgs.checkMembership({ org, username })
route: GET /orgs/{org}/members/{username}
scope: orgs
type: API method
---

# Check membership
# Check organization membership for a user

**Deprecated:** This method has been renamed to orgs.checkMembershipForUser

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

Expand Down Expand Up @@ -37,4 +39,4 @@ octokit.orgs.checkMembership({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-membership).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-organization-membership-for-a-user).
40 changes: 40 additions & 0 deletions docs/orgs/checkMembershipForUser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Check organization membership for a user
example: octokit.orgs.checkMembershipForUser({ org, username })
route: GET /orgs/{org}/members/{username}
scope: orgs
type: API method
---

# Check organization membership for a user

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

```js
octokit.orgs.checkMembershipForUser({
org,
username,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

</td></tr>
<tr><td>username</td><td>yes</td><td>

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-organization-membership-for-a-user).
8 changes: 5 additions & 3 deletions docs/orgs/checkPublicMembership.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: Check public membership
name: Check public organization membership for a user
example: octokit.orgs.checkPublicMembership({ org, username })
route: GET /orgs/{org}/public_members/{username}
scope: orgs
type: API method
---

# Check public membership
# Check public organization membership for a user

**Deprecated:** This method has been renamed to orgs.checkPublicMembershipForUser

```js
octokit.orgs.checkPublicMembership({
Expand Down Expand Up @@ -35,4 +37,4 @@ octokit.orgs.checkPublicMembership({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-membership).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-organization-membership-for-a-user).
38 changes: 38 additions & 0 deletions docs/orgs/checkPublicMembershipForUser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Check public organization membership for a user
example: octokit.orgs.checkPublicMembershipForUser({ org, username })
route: GET /orgs/{org}/public_members/{username}
scope: orgs
type: API method
---

# Check public organization membership for a user

```js
octokit.orgs.checkPublicMembershipForUser({
org,
username,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

</td></tr>
<tr><td>username</td><td>yes</td><td>

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#check-public-organization-membership-for-a-user).
8 changes: 5 additions & 3 deletions docs/orgs/concealMembership.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: Conceal a user's membership
name: Remove public organization membership for the authenticated user
example: octokit.orgs.concealMembership({ org, username })
route: DELETE /orgs/{org}/public_members/{username}
scope: orgs
type: API method
---

# Conceal a user's membership
# Remove public organization membership for the authenticated user

**Deprecated:** This method has been renamed to orgs.removePublicMembershipForAuthenticatedUser

```js
octokit.orgs.concealMembership({
Expand Down Expand Up @@ -35,4 +37,4 @@ octokit.orgs.concealMembership({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#conceal-a-users-membership).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#remove-public-organization-membership-for-the-authenticated-user).
6 changes: 3 additions & 3 deletions docs/orgs/convertMemberToOutsideCollaborator.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Convert member to outside collaborator
name: Convert an organization member to outside collaborator
example: octokit.orgs.convertMemberToOutsideCollaborator({ org, username })
route: PUT /orgs/{org}/outside_collaborators/{username}
scope: orgs
type: API method
---

# Convert member to outside collaborator
# Convert an organization member to outside collaborator

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)".

Expand Down Expand Up @@ -37,4 +37,4 @@ octokit.orgs.convertMemberToOutsideCollaborator({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/outside_collaborators/#convert-an-organization-member-to-outside-collaborator).
8 changes: 5 additions & 3 deletions docs/orgs/createHook.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: Create a hook
name: Create an organization webhook
example: octokit.orgs.createHook({ org, name, config, config.url })
route: POST /orgs/{org}/hooks
scope: orgs
type: API method
---

# Create a hook
# Create an organization webhook

**Deprecated:** This method has been renamed to orgs.createWebhook

Here's how you can create a hook that posts payloads in JSON format:

Expand Down Expand Up @@ -76,4 +78,4 @@ Determines if notifications are sent when the webhook is triggered. Set to `true
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/hooks/#create-a-hook).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/hooks/#create-an-organization-webhook).
6 changes: 3 additions & 3 deletions docs/orgs/createInvitation.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Create organization invitation
name: Create an organization invitation
example: octokit.orgs.createInvitation({ org })
route: POST /orgs/{org}/invitations
scope: orgs
type: API method
---

# Create organization invitation
# Create an organization invitation

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

Expand Down Expand Up @@ -58,4 +58,4 @@ Specify IDs for the teams you want to invite new members to.
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#create-organization-invitation).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/members/#create-an-organization-invitation).
79 changes: 79 additions & 0 deletions docs/orgs/createWebhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
name: Create an organization webhook
example: octokit.orgs.createWebhook({ org, name, config, config.url })
route: POST /orgs/{org}/hooks
scope: orgs
type: API method
---

# Create an organization webhook

Here's how you can create a hook that posts payloads in JSON format:

```js
octokit.orgs.createWebhook({
org,
name,
config,
config.url
})
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

</td></tr>
<tr><td>name</td><td>yes</td><td>

Must be passed as "web".

</td></tr>
<tr><td>config</td><td>yes</td><td>

Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).

</td></tr>
<tr><td>config.url</td><td>yes</td><td>

The URL to which the payloads will be delivered.

</td></tr>
<tr><td>config.content_type</td><td>no</td><td>

The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.

</td></tr>
<tr><td>config.secret</td><td>no</td><td>

If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/event-payloads/#delivery-headers) header.

</td></tr>
<tr><td>config.insecure_ssl</td><td>no</td><td>

Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**

</td></tr>
<tr><td>events</td><td>no</td><td>

Determines what [events](https://developer.github.com/webhooks/event-payloads) the hook is triggered for.

</td></tr>
<tr><td>active</td><td>no</td><td>

Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/orgs/hooks/#create-an-organization-webhook).
Loading