Merge branch 'main' into lucalves/spelling-fix
This commit is contained in:
Janice
@@ -10,7 +10,7 @@ versions:
|
||||
enterprise-server: '*'
|
||||
---
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% data reusables.pre-release-program.machine-man-preview %}
|
||||
{% data reusables.pre-release-program.api-preview-warning %}
|
||||
{% endif %}
|
||||
@@ -94,7 +94,7 @@ Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_AP
|
||||
|
||||
After creating the JWT, set it in the `Header` of the API request:
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
```shell
|
||||
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.machine-man-preview+json" {% data variables.product.api_url_pre %}/app
|
||||
```
|
||||
@@ -129,7 +129,7 @@ By default, installation access tokens are scoped to all the repositories that a
|
||||
|
||||
To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request:
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
```shell
|
||||
$ curl -i -X POST \
|
||||
-H "Authorization: Bearer YOUR_JWT" \
|
||||
@@ -149,7 +149,7 @@ The response will include your installation access token, the expiration date, t
|
||||
|
||||
To authenticate with an installation access token, include it in the Authorization header in the API request:
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
```shell
|
||||
$ curl -i \
|
||||
-H "Authorization: token YOUR_INSTALLATION_ACCESS_TOKEN" \
|
||||
|
||||
@@ -162,7 +162,7 @@ You must complete this step of the GitHub App Manifest flow within one hour.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||
{% data reusables.pre-release-program.fury-pre-release %}
|
||||
{% data reusables.pre-release-program.api-preview-warning %}
|
||||
{% endif %}
|
||||
|
||||
@@ -136,7 +136,7 @@ For more information about authorizing users using the device flow, see "[Author
|
||||
|
||||
### Check which installation's resources a user can access
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% data reusables.pre-release-program.machine-man-preview %}
|
||||
{% data reusables.pre-release-program.api-preview-warning %}
|
||||
{% endif %}
|
||||
@@ -422,7 +422,7 @@ While most of your API interaction should occur using your server-to-server inst
|
||||
* [Convert an organization member to outside collaborator](/v3/orgs/outside_collaborators/#convert-an-organization-member-to-outside-collaborator)
|
||||
* [Remove outside collaborator from an organization](/v3/orgs/outside_collaborators/#remove-outside-collaborator-from-an-organization)
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
##### Organization Pre Receive Hooks
|
||||
|
||||
* [List pre-receive hooks for an organization](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization)
|
||||
@@ -460,7 +460,7 @@ While most of your API interaction should occur using your server-to-server inst
|
||||
* [List teams](/v3/teams/#list-teams)
|
||||
* [Create a team](/v3/teams/#create-a-team)
|
||||
* [Get a team by name](/v3/teams/#get-a-team-by-name)
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.21" %}
|
||||
* [Get a team](/v3/teams/#get-a-team)
|
||||
{% endif %}
|
||||
* [Update a team](/v3/teams/#update-a-team)
|
||||
@@ -762,7 +762,7 @@ While most of your API interaction should occur using your server-to-server inst
|
||||
* [Get GitHub Pages build](/rest/reference/repos#get-github-pages-build)
|
||||
* [Get latest pages build](/rest/reference/repos#get-latest-pages-build)
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
##### Repository Pre Receive Hooks
|
||||
|
||||
* [List pre-receive hooks for a repository](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository)
|
||||
|
||||
@@ -38,7 +38,7 @@ X-Accepted-OAuth-Scopes: user
|
||||
|
||||
Name | Description
|
||||
-----|-----------|
|
||||
**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if currentVersion != "free-pro-team@latest" %}
|
||||
**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion %}
|
||||
**`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/v3/enterprise-admin).{% endif %}
|
||||
**`repo`** | Grants full access to private and public repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for public and private repositories and organizations. Also grants ability to manage user projects.
|
||||
 `repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code.
|
||||
|
||||
@@ -29,7 +29,7 @@ As an alternative to the email service, you can now start using email notificati
|
||||
|
||||
GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrator’s services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub.
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
### Finding repositories that use GitHub Services
|
||||
We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %}
|
||||
|
||||
|
||||
@@ -11,9 +11,9 @@ versions:
|
||||
|
||||
Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.
|
||||
|
||||
Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
|
||||
Webhooks can be installed on{% if enterpriseServerVersions contains currentVersion %} a [{% data variables.product.prodname_ghe_server %} instance](/rest/reference/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
|
||||
|
||||
You can create up to {% if currentVersion != "free-pro-team@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if currentVersion != "free-pro-team@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
|
||||
You can create up to {% if enterpriseServerVersions contains currentVersion %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if enterpriseServerVersions contains currentVersion %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
|
||||
|
||||
### Events
|
||||
|
||||
|
||||
@@ -348,7 +348,7 @@ The issue or pull request was locked.
|
||||
|
||||
#### Event object properties
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% data reusables.pre-release-program.sailor-v-preview %}
|
||||
{% data reusables.pre-release-program.api-preview-warning %}
|
||||
{% endif %}
|
||||
@@ -668,7 +668,7 @@ The issue was unlocked.
|
||||
|
||||
#### Event object properties
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.22" %}
|
||||
{% data reusables.pre-release-program.sailor-v-preview %}
|
||||
{% data reusables.pre-release-program.api-preview-warning %}
|
||||
{% endif %}
|
||||
|
||||
@@ -47,7 +47,7 @@ HTTP POST payloads that are delivered to your webhook's configured URL endpoint
|
||||
Header | Description
|
||||
-------|-------------|
|
||||
`X-GitHub-Event`| Name of the event that triggered the delivery.
|
||||
`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if currentVersion != "free-pro-team@latest" %}
|
||||
`X-GitHub-Delivery`| A [GUID](http://en.wikipedia.org/wiki/Globally_unique_identifier) to identify the delivery.{% if enterpriseServerVersions contains currentVersion %}
|
||||
`X-GitHub-Enterprise-Version` | The version of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.
|
||||
`X-GitHub-Enterprise-Host` | The hostname of the {% data variables.product.prodname_ghe_server %} instance that sent the HTTP POST payload.{% endif %}{% if currentVersion != "private-instances@latest" %}
|
||||
`X-Hub-Signature`| This header is sent if the webhook is configured with a [`secret`](/v3/repos/hooks/#create-hook-config-params). This is the HMAC hex digest of the request body, and is generated using the SHA-1 hash function and the `secret` as the HMAC `key`.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} `X-Hub-Signature` is provided for compatibility with existing integrations, and we recommend that you use the more secure `X-Hub-Signature-256` instead.{% endif %}{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
||||
@@ -61,7 +61,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
|
||||
> POST /payload HTTP/1.1
|
||||
|
||||
> Host: localhost:4567
|
||||
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if currentVersion != "free-pro-team@latest" %}
|
||||
> X-GitHub-Delivery: 72d3162e-cc78-11e3-81ab-4c9367dc0958{% if enterpriseServerVersions contains currentVersion %}
|
||||
> X-GitHub-Enterprise-Version: 2.15.0
|
||||
> X-GitHub-Enterprise-Host: example.com{% endif %}{% if currentVersion != "private-instances@latest" %}
|
||||
> X-Hub-Signature: sha1=7d38cdd689735b008b3c702edd92eea23791c5f6{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "private-instances@latest" %}
|
||||
@@ -332,7 +332,7 @@ Key | Type | Description
|
||||
|
||||
{{ webhookPayloadsForCurrentVersion.deployment_status }}
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
### enterprise
|
||||
|
||||
@@ -667,7 +667,7 @@ Key | Type | Description
|
||||
|
||||
#### Availability
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %}
|
||||
- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events
|
||||
- {% data variables.product.prodname_github_app %}s with the `members` permission
|
||||
@@ -676,7 +676,7 @@ Key | Type | Description
|
||||
|
||||
Key | Type | Description
|
||||
----|------|-------------
|
||||
`action` |`string` | The action that was performed. Can be one of:{% if currentVersion != "free-pro-team@latest" %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
|
||||
`action` |`string` | The action that was performed. Can be one of:{% if enterpriseServerVersions contains currentVersion %} `created`,{% endif %} `deleted`, `renamed`, `member_added`, `member_removed`, or `member_invited`.
|
||||
`invitation` |`object` | The invitation for the user or email if the action is `member_invited`.
|
||||
`membership` |`object` | The membership between the user and the organization. Not present when the action is `member_invited`.
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
@@ -1045,7 +1045,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
|
||||
|
||||
Key | Type | Description
|
||||
----|------|-------------
|
||||
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if currentVersion != "free-pro-team@latest" %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
||||
`action` |`string` | The action that was performed. This can be one of:<ul><li>`created` - A repository is created.</li><li>`deleted` - A repository is deleted. This event type is only available to [organization hooks](/rest/reference/orgs#webhooks/)</li><li>`archived` - A repository is archived.</li><li>`unarchived` - A repository is unarchived.</li>{% if enterpriseServerVersions contains currentVersion %}<li>`anonymous_access_enabled` - A repository is [enabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories), `anonymous_access_disabled` - A repository is [disabled for anonymous Git access](/v3/previews/#anonymous-git-access-to-repositories)</li>{% endif %}<li>`edited` - A repository's information is edited.</li><li>`renamed` - A repository is renamed.</li><li>`transferred` - A repository is transferred.</li><li>`publicized` - A repository is made public.</li><li> `privatized` - A repository is made private.</li></ul>
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
@@ -1247,7 +1247,7 @@ Key | Type | Description
|
||||
|
||||
{{ webhookPayloadsForCurrentVersion.team_add }}
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
||||
### user
|
||||
|
||||
|
||||
Reference in New Issue
Block a user