зеркало из https://github.com/github/docs.git
Branch was updated using the 'autoupdate branch' Actions workflow.
This commit is contained in:
Коммит
68ecb92c31
|
@ -232,7 +232,7 @@ on:
|
|||
|
||||
#### `deployment`
|
||||
|
||||
Runs your workflow anytime someone creates a deployment, which triggers the `deployment` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Deployments](/v3/repos/deployments/)."
|
||||
Runs your workflow anytime someone creates a deployment, which triggers the `deployment` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Deployments](/rest/reference/repos#deployments)."
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
|
@ -247,7 +247,7 @@ on:
|
|||
|
||||
#### `deployment_status`
|
||||
|
||||
Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/v3/repos/deployments/#create-a-deployment-status)."
|
||||
Runs your workflow anytime a third party provides a deployment status, which triggers the `deployment_status` event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "[Create a deployment status](/rest/reference/repos#create-a-deployment-status)."
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
|
@ -296,13 +296,13 @@ on:
|
|||
|
||||
#### `issue_comment`
|
||||
|
||||
Runs your workflow anytime the `issue_comment` event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "[Issue comments](/v3/issues/comments/)."
|
||||
Runs your workflow anytime the `issue_comment` event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "[Issue comments](/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment)."
|
||||
|
||||
{% data reusables.github-actions.branch-requirement %}
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
| [`issue_comment`](/v3/activity/event_types/#issue_comment) | - `created`<br/>- `edited`<br/>- `deleted`<br/> | Last commit on default branch | Default branch |
|
||||
| [`issue_comment`](/rest/reference/activity#issue_comment) | - `created`<br/>- `edited`<br/>- `deleted`<br/> | Last commit on default branch | Default branch |
|
||||
|
||||
{% data reusables.developer-site.limit_workflow_to_activity_types %}
|
||||
|
||||
|
@ -376,7 +376,7 @@ on:
|
|||
|
||||
#### `page_build`
|
||||
|
||||
Runs your workflow anytime someone pushes to a {% data variables.product.product_name %} Pages-enabled branch, which triggers the `page_build` event. For information about the REST API, see "[Pages](/v3/repos/pages/)."
|
||||
Runs your workflow anytime someone pushes to a {% data variables.product.product_name %} Pages-enabled branch, which triggers the `page_build` event. For information about the REST API, see "[Pages](/rest/reference/repos#pages)."
|
||||
|
||||
{% data reusables.github-actions.branch-requirement %}
|
||||
|
||||
|
|
|
@ -54,7 +54,7 @@ Permission | Description
|
|||
[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/v3/checks/). Can be one of: `none`, `read`, or `write`.
|
||||
`content_references` | Grants access to the "[Create a content attachment](/v3/apps/installations/#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`.
|
||||
[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`.
|
||||
[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/v3/repos/deployments/). Can be one of: `none`, `read`, or `write`.
|
||||
[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.
|
||||
[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/v3/users/emails/). Can be one of: `none`, `read`, or `write`.
|
||||
[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/v3/users/followers/). Can be one of: `none`, `read`, or `write`.
|
||||
[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/v3/users/gpg_keys/). Can be one of: `none`, `read`, or `write`.
|
||||
|
@ -63,11 +63,11 @@ Permission | Description
|
|||
[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% if currentVersion == "free-pro-team@latest" %}
|
||||
[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}.
|
||||
[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/v3/orgs/#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/v3/interactions/orgs/#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/v3/orgs/hooks/). Can be one of: `none`, `read`, or `write`.
|
||||
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`.
|
||||
`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/v3/orgs/#get-an-organization)" endpoint. Can be one of: `none` or `read`.
|
||||
[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/v3/projects/). Can be one of: `none`, `read`, `write`, or `admin`.{% if currentVersion == "free-pro-team@latest" %}
|
||||
[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/v3/orgs/blocking/). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/v3/repos/pages/). Can be one of: `none`, `read`, or `write`.
|
||||
[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`.
|
||||
`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/v3/users/#get-a-user)" endpoint. Can be one of: `none` or `read`.
|
||||
[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`.
|
||||
[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/v3/repos/hooks/). Can be one of: `none`, `read`, or `write`.
|
||||
|
|
|
@ -241,25 +241,25 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
|
||||
##### Deployment Statuses
|
||||
|
||||
* [List deployment statuses](/v3/repos/deployments/#list-deployment-statuses)
|
||||
* [Create a deployment status](/v3/repos/deployments/#create-a-deployment-status)
|
||||
* [Get a deployment status](/v3/repos/deployments/#get-a-deployment-status)
|
||||
* [List deployment statuses](/rest/reference/repos#list-deployment-statuses)
|
||||
* [Create a deployment status](/rest/reference/repos#create-a-deployment-status)
|
||||
* [Get a deployment status](/rest/reference/repos#get-a-deployment-status)
|
||||
|
||||
##### Deployments
|
||||
|
||||
* [List deployments](/v3/repos/deployments/#list-deployments)
|
||||
* [Create a deployment](/v3/repos/deployments/#create-a-deployment)
|
||||
* [Get a deployment](/v3/repos/deployments/#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
* [Delete a deployment](/v3/repos/deployments/#delete-a-deployment){% endif %}
|
||||
* [List deployments](/rest/reference/repos#list-deployments)
|
||||
* [Create a deployment](/rest/reference/repos#create-a-deployment)
|
||||
* [Get a deployment](/rest/reference/repos#get-a-deployment){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
* [Delete a deployment](/rest/reference/repos#delete-a-deployment){% endif %}
|
||||
|
||||
##### Events
|
||||
|
||||
* [List public events for a network of repositories](/v3/activity/events/#list-public-events-for-a-network-of-repositories)
|
||||
* [List public organization events](/v3/activity/events/#list-public-organization-events)
|
||||
* [List public events for a network of repositories](/rest/reference/activity#list-public-events-for-a-network-of-repositories)
|
||||
* [List public organization events](/rest/reference/activity#list-public-organization-events)
|
||||
|
||||
##### Feeds
|
||||
|
||||
* [Get feeds](/v3/activity/feeds/#get-feeds)
|
||||
* [Get feeds](/rest/reference/activity#get-feeds)
|
||||
|
||||
##### Git Blobs
|
||||
|
||||
|
@ -388,12 +388,12 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
|
||||
##### Organization Hooks
|
||||
|
||||
* [List organization webhooks](/v3/orgs/hooks/#list-organization-webhooks)
|
||||
* [Create an organization webhook](/v3/orgs/hooks/#create-an-organization-webhook)
|
||||
* [Get an organization webhook](/v3/orgs/hooks/#get-an-organization-webhook)
|
||||
* [Update an organization webhook](/v3/orgs/hooks/#update-an-organization-webhook)
|
||||
* [Delete an organization webhook](/v3/orgs/hooks/#delete-an-organization-webhook)
|
||||
* [Ping an organization webhook](/v3/orgs/hooks/#ping-an-organization-webhook)
|
||||
* [List organization webhooks](/rest/reference/orgs#webhooks/#list-organization-webhooks)
|
||||
* [Create an organization webhook](/rest/reference/orgs#webhooks/#create-an-organization-webhook)
|
||||
* [Get an organization webhook](/rest/reference/orgs#webhooks/#get-an-organization-webhook)
|
||||
* [Update an organization webhook](/rest/reference/orgs#webhooks/#update-an-organization-webhook)
|
||||
* [Delete an organization webhook](/rest/reference/orgs#webhooks/#delete-an-organization-webhook)
|
||||
* [Ping an organization webhook](/rest/reference/orgs#webhooks/#ping-an-organization-webhook)
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
##### Organization Invitations
|
||||
|
@ -616,7 +616,7 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
* [Delete a repository](/v3/repos/#delete-a-repository)
|
||||
* [Compare two commits](/v3/repos/commits/#compare-two-commits)
|
||||
* [List repository contributors](/v3/repos/#list-repository-contributors)
|
||||
* [List forks](/v3/repos/forks/#list-forks)
|
||||
* [List forks](/rest/reference/repos#list-forks)
|
||||
* [Create a fork](/v3/repos/forks/#create-a-fork)
|
||||
* [List repository languages](/v3/repos/#list-repository-languages)
|
||||
* [List repository tags](/v3/repos/#list-repository-tags)
|
||||
|
@ -629,13 +629,13 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
|
||||
##### Repository Activity
|
||||
|
||||
* [List stargazers](/v3/activity/starring/#list-stargazers)
|
||||
* [List watchers](/v3/activity/watching/#list-watchers)
|
||||
* [List repositories starred by a user](/v3/activity/starring/#list-repositories-starred-by-a-user)
|
||||
* [Check if a repository is starred by the authenticated user](/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user)
|
||||
* [Star a repository for the authenticated user](/v3/activity/starring/#star-a-repository-for-the-authenticated-user)
|
||||
* [Unstar a repository for the authenticated user](/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user)
|
||||
* [List repositories watched by a user](/v3/activity/watching/#list-repositories-watched-by-a-user)
|
||||
* [List stargazers](/rest/reference/activity#list-stargazers)
|
||||
* [List watchers](/rest/reference/activity#list-watchers)
|
||||
* [List repositories starred by a user](/rest/reference/activity#list-repositories-starred-by-a-user)
|
||||
* [Check if a repository is starred by the authenticated user](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user)
|
||||
* [Star a repository for the authenticated user](/rest/reference/activity#star-a-repository-for-the-authenticated-user)
|
||||
* [Unstar a repository for the authenticated user](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user)
|
||||
* [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user)
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||
##### Repository Automated Security Fixes
|
||||
|
@ -753,14 +753,14 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
|
||||
##### Repository Pages
|
||||
|
||||
* [Get a GitHub Pages site](/v3/repos/pages/#get-a-github-pages-site)
|
||||
* [Create a GitHub Pages site](/v3/repos/pages/#create-a-github-pages-site)
|
||||
* [Update information about a GitHub Pages site](/v3/repos/pages/#update-information-about-a-github-pages-site)
|
||||
* [Delete a GitHub Pages site](/v3/repos/pages/#delete-a-github-pages-site)
|
||||
* [List GitHub Pages builds](/v3/repos/pages/#list-github-pages-builds)
|
||||
* [Request a GitHub Pages build](/v3/repos/pages/#request-a-github-pages-build)
|
||||
* [Get GitHub Pages build](/v3/repos/pages/#get-github-pages-build)
|
||||
* [Get latest pages build](/v3/repos/pages/#get-latest-pages-build)
|
||||
* [Get a GitHub Pages site](/rest/reference/repos#get-a-github-pages-site)
|
||||
* [Create a GitHub Pages site](/rest/reference/repos#create-a-github-pages-site)
|
||||
* [Update information about a GitHub Pages site](/rest/reference/repos#update-information-about-a-github-pages-site)
|
||||
* [Delete a GitHub Pages site](/rest/reference/repos#delete-a-github-pages-site)
|
||||
* [List GitHub Pages builds](/rest/reference/repos#list-github-pages-builds)
|
||||
* [Request a GitHub Pages build](/rest/reference/repos#request-a-github-pages-build)
|
||||
* [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" %}
|
||||
##### Repository Pre Receive Hooks
|
||||
|
@ -773,17 +773,17 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
|
||||
##### Repository Releases
|
||||
|
||||
* [List releases](/v3/repos/releases/#list-releases)
|
||||
* [Create a release](/v3/repos/releases/#create-a-release)
|
||||
* [Get a release](/v3/repos/releases/#get-a-release)
|
||||
* [Update a release](/v3/repos/releases/#update-a-release)
|
||||
* [Delete a release](/v3/repos/releases/#delete-a-release)
|
||||
* [List release assets](/v3/repos/releases/#list-release-assets)
|
||||
* [Get a release asset](/v3/repos/releases/#get-a-release-asset)
|
||||
* [Update a release asset](/v3/repos/releases/#update-a-release-asset)
|
||||
* [Delete a release asset](/v3/repos/releases/#delete-a-release-asset)
|
||||
* [Get the latest release](/v3/repos/releases/#get-the-latest-release)
|
||||
* [Get a release by tag name](/v3/repos/releases/#get-a-release-by-tag-name)
|
||||
* [List releases](/rest/reference/repos/#list-releases)
|
||||
* [Create a release](/rest/reference/repos/#create-a-release)
|
||||
* [Get a release](/rest/reference/repos/#get-a-release)
|
||||
* [Update a release](/rest/reference/repos/#update-a-release)
|
||||
* [Delete a release](/rest/reference/repos/#delete-a-release)
|
||||
* [List release assets](/rest/reference/repos/#list-release-assets)
|
||||
* [Get a release asset](/rest/reference/repos/#get-a-release-asset)
|
||||
* [Update a release asset](/rest/reference/repos/#update-a-release-asset)
|
||||
* [Delete a release asset](/rest/reference/repos/#delete-a-release-asset)
|
||||
* [Get the latest release](/rest/reference/repos/#get-the-latest-release)
|
||||
* [Get a release by tag name](/rest/reference/repos/#get-a-release-by-tag-name)
|
||||
|
||||
##### Repository Stats
|
||||
|
||||
|
|
|
@ -11,7 +11,7 @@ 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](/v3/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 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.
|
||||
|
||||
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 %}
|
||||
|
||||
|
@ -29,5 +29,5 @@ See "[Webhook event payloads](/webhooks/event-payloads)" for the list of availab
|
|||
|
||||
For more information about the `ping` event webhook payload, see the [`ping`](/webhooks/event-payloads/#ping) event.
|
||||
|
||||
[org-hooks]: /v3/orgs/hooks/
|
||||
[org-hooks]: /rest/reference/orgs#webhooks/
|
||||
[repo-hooks]: /v3/repos/hooks/
|
||||
|
|
|
@ -291,7 +291,7 @@ Only {% data variables.product.prodname_github_app %}s can receive this event. {
|
|||
Key | Type | Description
|
||||
----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
`action` |`string` | The action performed. Can be `created`.{% endif %}
|
||||
`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments).
|
||||
`deployment` |`object` | The [deployment](/rest/reference/repos#list-deployments).
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
|
@ -316,11 +316,11 @@ Key | Type | Description
|
|||
Key | Type | Description
|
||||
----|------|-------------{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
`action` |`string` | The action performed. Can be `created`.{% endif %}
|
||||
`deployment_status` |`object` | The [deployment status](/v3/repos/deployments/#list-deployment-statuses).
|
||||
`deployment_status` |`object` | The [deployment status](/rest/reference/repos#list-deployment-statuses).
|
||||
`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
|
||||
`deployment_status["target_url"]` |`string` | The optional link added to the status.
|
||||
`deployment_status["description"]`|`string` | The optional human-readable description added to the status.
|
||||
`deployment` |`object` | The [deployment](/v3/repos/deployments/#list-deployments) that this status is associated with.
|
||||
`deployment` |`object` | The [deployment](/rest/reference/repos#list-deployments) that this status is associated with.
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
|
@ -338,7 +338,7 @@ Key | Type | Description
|
|||
|
||||
#### Availability
|
||||
|
||||
- GitHub Enterprise webhooks. For more information, "[Global webhooks](/v3/enterprise-admin/global_webhooks/)."
|
||||
- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)."
|
||||
|
||||
#### Webhook payload object
|
||||
|
||||
|
@ -666,7 +666,7 @@ Key | Type | Description
|
|||
#### Availability
|
||||
|
||||
{% if currentVersion != "free-pro-team@latest" %}
|
||||
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/v3/enterprise-admin/global_webhooks/).{% endif %}
|
||||
- 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
|
||||
|
||||
|
@ -746,7 +746,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus
|
|||
Key | Type | Description
|
||||
----|------|------------
|
||||
`id` | `integer` | The unique identifier of the page build.
|
||||
`build` | `object` | The [List GitHub Pages builds](/v3/repos/pages/#list-github-pages-builds) itself.
|
||||
`build` | `object` | The [List GitHub Pages builds](/rest/reference/repos#list-github-pages-builds) itself.
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
|
@ -1039,7 +1039,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](/v3/orgs/hooks/)</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 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>
|
||||
{% data reusables.webhooks.repo_desc %}
|
||||
{% data reusables.webhooks.org_desc %}
|
||||
{% data reusables.webhooks.app_desc %}
|
||||
|
@ -1248,7 +1248,7 @@ Key | Type | Description
|
|||
When a user is `created` or `deleted`.
|
||||
|
||||
#### Availability
|
||||
- GitHub Enterprise webhooks. For more information, "[Global webhooks](/v3/enterprise-admin/global_webhooks/)."
|
||||
- GitHub Enterprise webhooks. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/)."
|
||||
|
||||
#### Webhook payload example
|
||||
|
||||
|
|
|
@ -16,7 +16,7 @@ versions:
|
|||
|
||||
### About release management
|
||||
|
||||
You can also publish an action from a specific release in {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action in the {% data variables.product.prodname_marketplace %}](/actions/creating-actions/publishing-actions-in-github-marketplace)."
|
||||
You can also publish an action from a specific release in {% data variables.product.prodname_marketplace %}. For more information, see "<a href="/actions/creating-actions/publishing-actions-in-github-marketplace" class="dotcom-only">Publishing an action in the {% data variables.product.prodname_marketplace %}</a>."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}
|
||||
You can choose whether {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) objects are included in the ZIP files and tarballs that {% data variables.product.product_name %} creates for each release. For more information, see "[Managing {% data variables.large_files.product_name_short %} objects in archives of your repository](/github/administering-a-repository/managing-git-lfs-objects-in-archives-of-your-repository)."
|
||||
|
@ -49,7 +49,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da
|
|||
9. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**.
|
||||
![Publish release and Draft release buttons](/assets/images/help/releases/release_buttons.png)
|
||||
|
||||
You can also automatically create a release from the command line or in a script. For more information, see "[Releases](/v3/repos/releases/#create-a-release)."
|
||||
You can also automatically create a release from the command line or in a script. For more information, see "[Releases](/rest/reference/repos/#create-a-release)."
|
||||
|
||||
### Editing a release
|
||||
|
||||
|
|
|
@ -14,7 +14,7 @@ versions:
|
|||
|
||||
{% endnote %}
|
||||
|
||||
People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with {% data variables.product.product_name %} through the Deployments API or an app from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment). For more information, see "[Deployments](/v3/repos/deployments/)."
|
||||
People with read access to a repository can see an overview of all current deployments and a log of past deployment activity, if the repository's deployment workflow is integrated with {% data variables.product.product_name %} through the Deployments API or an app from [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace/category/deployment). For more information, see "[Deployments](/rest/reference/repos#deployments)."
|
||||
|
||||
You can also see deployment information on the "Conversation" tab of a pull request.
|
||||
|
||||
|
|
|
@ -46,7 +46,7 @@ You can navigate between the checks summaries for various commits in a pull requ
|
|||
|
||||
#### Skipping and requesting checks for individual commits
|
||||
|
||||
When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see "[Check Suites](/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)."
|
||||
When a repository is set to automatically request checks for pushes, you can choose to skip checks for an individual commit you push. When a repository is _not_ set to automatically request checks for pushes, you can request checks for an individual commit you push. For more information on these settings, see "[Check Suites](/rest/reference/checks#update-repository-preferences-for-check-suites)."
|
||||
|
||||
To skip or request checks for your commit, add one of the following trailer lines to the end of your commit message:
|
||||
|
||||
|
|
|
@ -21,12 +21,12 @@ When you clone a repository or wiki, only Git data, such as project files and co
|
|||
|
||||
- [Issues](/v3/issues/#list-issues-for-a-repository)
|
||||
- [Pull requests](/v3/pulls/#list-pull-requests)
|
||||
- [Forks](/v3/repos/forks/#list-forks)
|
||||
- [Comments](/v3/issues/comments/#list-comments-in-a-repository)
|
||||
- [Milestones](/v3/issues/milestones/#list-milestones-for-a-repository)
|
||||
- [Labels](/v3/issues/labels/#list-all-labels-for-this-repository)
|
||||
- [Watchers](/v3/activity/watching/#list-watchers)
|
||||
- [Stargazers](/v3/activity/starring/#list-stargazers)
|
||||
- [Forks](/rest/reference/repos#list-forks)
|
||||
- [Comments](/rest/reference/issues#list-issue-comments-for-a-repository)
|
||||
- [Milestones](/rest/reference/issues#list-milestones)
|
||||
- [Labels](/rest/reference/issues#list-labels-for-a-repository)
|
||||
- [Watchers](/rest/reference/activity#list-watchers)
|
||||
- [Stargazers](/rest/reference/activity#list-stargazers)
|
||||
- [Projects](/v3/projects/#list-repository-projects)
|
||||
{% endif %}
|
||||
|
||||
|
|
|
@ -32,8 +32,8 @@ Below is a list of some of the available keyboard shortcuts.
|
|||
|-----------|------------
|
||||
|<kbd>g</kbd> <kbd>c</kbd> | Go to the **Code** tab
|
||||
|<kbd>g</kbd> <kbd>i</kbd> | Go to the **Issues** tab. For more information, see "[About issues](/articles/about-issues)."
|
||||
|<kbd>g</kbd> <kbd>p</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."
|
||||
|<kbd>g</kbd> <kbd>a</kbd> | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."
|
||||
|<kbd>g</kbd> <kbd>p</kbd> | Go to the **Pull requests** tab. For more information, see "[About pull requests](/articles/about-pull-requests)."{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}
|
||||
|<kbd>g</kbd> <kbd>a</kbd> | Go to the **Actions** tab. For more information, see "[About Actions](/actions/getting-started-with-github-actions/about-github-actions)."{% endif %}
|
||||
|<kbd>g</kbd> <kbd>b</kbd> | Go to the **Projects** tab. For more information, see "[About project boards](/articles/about-project-boards)."
|
||||
|<kbd>g</kbd> <kbd>w</kbd> | Go to the **Wiki** tab. For more information, see "[About wikis](/articles/about-wikis)."
|
||||
|
||||
|
|
|
@ -418,7 +418,7 @@ To ensure a secure IP and maintain compliance for your organization, you can use
|
|||
|
||||
The GraphQL response can include data for up to 90 to 120 days.
|
||||
|
||||
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/v4/interface/auditentry/)."
|
||||
For example, you can make a GraphQL request to see all the new organization members added to your organization. For more information, see the "[GraphQL API Audit Log](/graphql/reference/interfaces#auditentry/)."
|
||||
|
||||
### Further reading
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ With the Audit Log API, you can monitor when someone:
|
|||
- Promotes users to admin.
|
||||
- Changes permissions of a GitHub App.
|
||||
|
||||
The Audit Log API enables you to keep copies of your audit log data. For queries made with the Audit Log API, the GraphQL response can include data for up to 90 to 120 days. For a list of the fields available with the Audit Log API, see the "[AuditEntry interface](/v4/interface/auditentry/)."
|
||||
The Audit Log API enables you to keep copies of your audit log data. For queries made with the Audit Log API, the GraphQL response can include data for up to 90 to 120 days. For a list of the fields available with the Audit Log API, see the "[AuditEntry interface](/graphql/reference/interfaces#auditentry/)."
|
||||
|
||||
With the Enterprise Accounts API, you can:
|
||||
- List and review all of the organizations and repositories that belong to your enterprise account.
|
||||
|
|
|
@ -127,10 +127,7 @@ application, you should probably use [a library written in the language of your
|
|||
|
||||
#### Checking granted scopes
|
||||
|
||||
In the future, users will be able to [edit the scopes you requested][edit scopes post],
|
||||
and your application might be granted less access than you originally asked for.
|
||||
So, before making any requests with the token, you should check the scopes that
|
||||
were granted for the token by the user.
|
||||
Users can edit the scopes you requested by directly changing the URL. This can grant your application less access than you originally asked for. Before making any requests with the token, check the scopes that were granted for the token by the user. For more information about requested and granted scopes, see "[Scopes for OAuth Apps](/developers/apps/scopes-for-oauth-apps#requested-scopes-and-granted-scopes)."
|
||||
|
||||
The scopes that were granted are returned as a part of the response from
|
||||
exchanging a token.
|
||||
|
@ -365,7 +362,6 @@ we would've seen the same confirmation dialog from earlier pop-up and warn us.
|
|||
[REST Client]: https://github.com/archiloque/rest-client
|
||||
[libraries]: /libraries/
|
||||
[oauth scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/
|
||||
[edit scopes post]: https://developer.github.com/changes/2013-10-04-oauth-changes-coming/
|
||||
[platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/basics-of-authentication
|
||||
[new oauth app]: https://github.com/settings/applications/new
|
||||
[app settings]: https://github.com/settings/developers
|
||||
|
|
|
@ -27,7 +27,7 @@ Allows you to download repositories from your GitHub user or organization accoun
|
|||
|
||||
### Enhanced deployments
|
||||
|
||||
Exercise greater control over [deployments](/v3/repos/deployments/) with more information and finer granularity.
|
||||
Exercise greater control over [deployments](/rest/reference/repos#deployments) with more information and finer granularity.
|
||||
|
||||
**Custom media type:** `ant-man-preview`
|
||||
**Announced:** [2016-04-06](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements/)
|
||||
|
@ -127,10 +127,10 @@ Include nested team content in [team](/v3/teams/) payloads.
|
|||
|
||||
### Global webhooks
|
||||
|
||||
Enables [global webhooks](/v3/enterprise-admin/global_webhooks/) for [organization](/webhooks/event-payloads/#organization) and [user](/webhooks/event-payloads/#user) event types. This API preview is only available for {% data variables.product.prodname_ghe_server %}.
|
||||
Enables [global webhooks](/rest/reference/enterprise-admin#global-webhooks/) for [organization](/webhooks/event-payloads/#organization) and [user](/webhooks/event-payloads/#user) event types. This API preview is only available for {% data variables.product.prodname_ghe_server %}.
|
||||
|
||||
**Custom media type:** `superpro-preview`
|
||||
**Announced:** [2017-12-12](/v3/enterprise-admin/global_webhooks)
|
||||
**Announced:** [2017-12-12](/rest/reference/enterprise-admin#global-webhooks)
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
@ -215,7 +215,7 @@ GitHub App Manifests allow people to create preconfigured GitHub Apps. See "[Cre
|
|||
|
||||
### Deployment statuses
|
||||
|
||||
You can now update the `environment` of a [deployment status](/v3/repos/deployments/#create-a-deployment-status) and use the `in_progress` and `queued` states. When you create deployment statuses, you can now use the `auto_inactive` parameter to mark old `production` deployments as `inactive`.
|
||||
You can now update the `environment` of a [deployment status](/rest/reference/repos#create-a-deployment-status) and use the `in_progress` and `queued` states. When you create deployment statuses, you can now use the `auto_inactive` parameter to mark old `production` deployments as `inactive`.
|
||||
|
||||
**Custom media type:** `flash-preview`
|
||||
**Announced:** [2018-10-16](https://developer.github.com/changes/2018-10-16-deployments-environments-states-and-auto-inactive-updates/)
|
||||
|
@ -257,7 +257,7 @@ You can use the Draft Pull Requests API and its [pull request](/v3/pulls/) endpo
|
|||
|
||||
### Enable and disable Pages
|
||||
|
||||
You can use the new endpoints in the [Pages API](/v3/repos/pages/) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)".
|
||||
You can use the new endpoints in the [Pages API](/rest/reference/repos#pages) to enable or disable Pages. To learn more about Pages, see "[GitHub Pages Basics](/categories/github-pages-basics)".
|
||||
|
||||
**Custom media types:** `switcheroo-preview`
|
||||
**Announced:** [2019-03-14](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/)
|
||||
|
|
|
@ -18,8 +18,8 @@ If a license is matched, the license key and name returned conforms to the [SPDX
|
|||
- [Get a repository](/v3/repos/#get-a-repository)
|
||||
- [List repositories for a user](/v3/repos/#list-repositories-for-a-user)
|
||||
- [List organization repositories](/v3/repos/#list-organization-repositories)
|
||||
- [List forks](/v3/repos/forks/#list-forks)
|
||||
- [List repositories watched by a user](/v3/activity/watching/#list-repositories-watched-by-a-user)
|
||||
- [List forks](/rest/reference/repos#list-forks)
|
||||
- [List repositories watched by a user](/rest/reference/activity#list-repositories-watched-by-a-user)
|
||||
- [List team repositories](/v3/teams/#list-team-repositories)
|
||||
|
||||
{% warning %}
|
||||
|
|
|
@ -22,7 +22,7 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe
|
|||
- [`GET /codes_of_conduct`](/v3/codes_of_conduct/#get-all-codes-of-conduct)
|
||||
- [`GET /codes_of_conduct/:key`](/v3/codes_of_conduct/#get-a-code-of-conduct)
|
||||
- [`GET /emojis`](/v3/emojis/#emojis)
|
||||
- [`GET /feeds`](/v3/activity/feeds/#get-feeds)
|
||||
- [`GET /feeds`](/rest/reference/activity#get-feeds)
|
||||
- [`GET /licenses`](/v3/licenses/#get-all-commonly-used-licenses)
|
||||
- [`GET /licenses/:key`](/v3/licenses/#get-a-license)
|
||||
- [`POST /markdown`](/v3/markdown/#render-a-markdown-document)
|
||||
|
@ -38,22 +38,22 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe
|
|||
- [`GET /repos/:owner/:repo/community/profile`](/v3/repos/community/#get-community-profile-metrics)
|
||||
{% endif %}
|
||||
- [`GET /repos/:owner/:repo/contributors`](/v3/repos/#list-repository-contributors)
|
||||
- [`GET /repos/:owner/:repo/forks`](/v3/repos/forks/#list-forks)
|
||||
- [`GET /repos/:owner/:repo/forks`](/rest/reference/repos#list-forks)
|
||||
- [`GET /repos/:owner/:repo/languages`](/v3/repos/#list-repository-languages)
|
||||
- [`GET /repos/:owner/:repo/license`](/v3/licenses/#get-the-license-for-a-repository)
|
||||
- [`GET /repos/:owner/:repo/stargazers`](/v3/activity/starring/#list-stargazers)
|
||||
- [`GET /repos/:owner/:repo/stargazers`](/rest/reference/activity#list-stargazers)
|
||||
- [`GET /repos/:owner/:repo/stats/code_frequency`](/v3/repos/statistics/#get-the-weekly-commit-activity)
|
||||
- [`GET /repos/:owner/:repo/stats/commit_activity`](/v3/repos/statistics/#get-the-last-year-of-commit-activity)
|
||||
- [`GET /repos/:owner/:repo/stats/contributors`](/v3/repos/statistics/#get-all-contributor-commit-activity)
|
||||
- [`GET /repos/:owner/:repo/stats/participation`](/v3/repos/statistics/#get-the-weekly-commit-count)
|
||||
- [`GET /repos/:owner/:repo/stats/punch_card`](/v3/repos/statistics/#get-the-hourly-commit-count-for-each-day)
|
||||
- [`GET /repos/:owner/:repo/subscribers`](/v3/activity/watching/#list-watchers)
|
||||
- [`GET /repos/:owner/:repo/subscribers`](/rest/reference/activity#list-watchers)
|
||||
- [`GET /repos/:owner/:repo/tags`](/v3/repos/#list-repository-tags)
|
||||
- [`GET /repos/:owner/:repo/topics`](/v3/repos#get-all-repository-topics)
|
||||
- [`GET /repositories`](/v3/repos/#list-public-repositories)
|
||||
- [`GET /user/repos`](/v3/repos/#list-repositories-for-the-authenticated-user)
|
||||
- [`GET /user/starred`](/v3/activity/starring/#list-repositories-starred-by-a-user)
|
||||
- [`GET /user/subscriptions`](/v3/activity/watching/#list-repositories-watched-by-a-user)
|
||||
- [`GET /user/starred`](/rest/reference/activity#list-repositories-starred-by-a-user)
|
||||
- [`GET /user/subscriptions`](/rest/reference/activity#list-repositories-watched-by-a-user)
|
||||
- [`GET /users`](/v3/users/#list-users)
|
||||
- [`GET /users/:username`](/v3/users/#get-a-user)
|
||||
- [`GET /users/:username/followers`](/v3/users/followers/#list-followers-of-a-user)
|
||||
|
@ -61,10 +61,10 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe
|
|||
- [`GET /users/:username/following/:target_user`](/v3/users/followers/#check-if-a-user-follows-another-user)
|
||||
- [`GET /users/:username/gpg_keys`](/v3/users/gpg_keys/#list-gpg-keys-for-a-user)
|
||||
- [`GET /users/:username/orgs`](/v3/orgs/#list-organizations-for-a-user)
|
||||
- [`GET /users/:username/received_events`](/v3/activity/events/#list-events-received-by-the-authenticated-user)
|
||||
- [`GET /users/:username/received_events/public`](/v3/activity/events/#list-public-events-received-by-a-user)
|
||||
- [`GET /users/:username/received_events`](/rest/reference/activity#list-events-received-by-the-authenticated-user)
|
||||
- [`GET /users/:username/received_events/public`](/rest/reference/activity#list-public-events-received-by-a-user)
|
||||
- [`GET /users/:username/repos`](/v3/repos/#list-repositories-for-a-user)
|
||||
- [`GET /users/:username/subscriptions`](/v3/activity/watching/#list-repositories-watched-by-a-user)
|
||||
- [`GET /users/:username/subscriptions`](/rest/reference/activity#list-repositories-watched-by-a-user)
|
||||
|
||||
_Collaborators_
|
||||
- [`GET /repos/:owner/:repo/collaborators`](/v3/repos/collaborators/#list-repository-collaborators)
|
||||
|
@ -77,12 +77,12 @@ _Commit comments_
|
|||
- [`GET /repos/:owner/:repo/commits/:sha/comments`](/v3/repos/comments/#list-commit-comments)
|
||||
|
||||
_Events_
|
||||
- [`GET /events`](/v3/activity/events/#list-public-events)
|
||||
- [`GET /networks/:owner/:repo/events`](/v3/activity/events/#list-public-events-for-a-network-of-repositories)
|
||||
- [`GET /orgs/:org/events`](/v3/activity/events/#list-public-organization-events)
|
||||
- [`GET /repos/:owner/:repo/events`](/v3/activity/events/#list-repository-events)
|
||||
- [`GET /users/:username/events`](/v3/activity/events/#list-events-for-the-authenticated-user)
|
||||
- [`GET /users/:username/events/public`](/v3/activity/events/#list-public-events-for-a-user)
|
||||
- [`GET /events`](/rest/reference/activity#list-public-events)
|
||||
- [`GET /networks/:owner/:repo/events`](/rest/reference/activity#list-public-events-for-a-network-of-repositories)
|
||||
- [`GET /orgs/:org/events`](/rest/reference/activity#list-public-organization-events)
|
||||
- [`GET /repos/:owner/:repo/events`](/rest/reference/activity#list-repository-events)
|
||||
- [`GET /users/:username/events`](/rest/reference/activity#list-events-for-the-authenticated-user)
|
||||
- [`GET /users/:username/events/public`](/rest/reference/activity#list-public-events-for-a-user)
|
||||
|
||||
_Git_
|
||||
- [`GET /gitignore/templates`](/v3/gitignore/#get-all-gitignore-templates)
|
||||
|
@ -392,27 +392,27 @@ _Reactions_
|
|||
- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/v3/reactions/#delete-team-discussion-comment-reaction) (:write){% endif %}
|
||||
|
||||
_Releases_
|
||||
- [`GET /repos/:owner/:repo/releases`](/v3/repos/releases/#list-releases) (:read)
|
||||
- [`POST /repos/:owner/:repo/releases`](/v3/repos/releases/#create-a-release) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/:release_id`](/v3/repos/releases/#get-a-release) (:read)
|
||||
- [`PATCH /repos/:owner/:repo/releases/:release_id`](/v3/repos/releases/#update-a-release) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/releases/:release_id`](/v3/repos/releases/#delete-a-release) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/v3/repos/releases/#list-release-assets) (:read)
|
||||
- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/v3/repos/releases/#get-a-release-asset) (:read)
|
||||
- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/v3/repos/releases/#update-a-release-asset) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/v3/repos/releases/#delete-a-release-asset) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/latest`](/v3/repos/releases/#get-the-latest-release) (:read)
|
||||
- [`GET /repos/:owner/:repo/releases/tags/:tag`](/v3/repos/releases/#get-a-release-by-tag-name) (:read)
|
||||
- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read)
|
||||
- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read)
|
||||
- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (:read)
|
||||
- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (:read)
|
||||
- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (:write)
|
||||
- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read)
|
||||
- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read)
|
||||
|
||||
### Permission on "deployments"
|
||||
|
||||
- [`GET /repos/:owner/:repo/deployments`](/v3/repos/deployments/#list-deployments) (:read)
|
||||
- [`POST /repos/:owner/:repo/deployments`](/v3/repos/deployments/#create-a-deployment) (:write)
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/v3/repos/deployments/#get-a-deployment) (:read){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/v3/repos/deployments/#delete-a-deployment) (:write){% endif %}
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/v3/repos/deployments/#list-deployment-statuses) (:read)
|
||||
- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/v3/repos/deployments/#create-a-deployment-status) (:write)
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/v3/repos/deployments/#get-a-deployment-status) (:read)
|
||||
- [`GET /repos/:owner/:repo/deployments`](/rest/reference/repos#list-deployments) (:read)
|
||||
- [`POST /repos/:owner/:repo/deployments`](/rest/reference/repos#create-a-deployment) (:write)
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/repos#get-a-deployment) (:read){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" %}
|
||||
- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/repos#delete-a-deployment) (:write){% endif %}
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/repos#list-deployment-statuses) (:read)
|
||||
- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/repos#create-a-deployment-status) (:write)
|
||||
- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/repos#get-a-deployment-status) (:read)
|
||||
|
||||
### Permission on "emails"
|
||||
|
||||
|
@ -609,12 +609,12 @@ _Teams_
|
|||
|
||||
### Permission on "organization hooks"
|
||||
|
||||
- [`GET /orgs/:org/hooks`](/v3/orgs/hooks/#list-organization-webhooks) (:read)
|
||||
- [`POST /orgs/:org/hooks`](/v3/orgs/hooks/#create-an-organization-webhook) (:write)
|
||||
- [`GET /orgs/:org/hooks/:hook_id`](/v3/orgs/hooks/#get-an-organization-webhook) (:read)
|
||||
- [`PATCH /orgs/:org/hooks/:hook_id`](/v3/orgs/hooks/#update-an-organization-webhook) (:write)
|
||||
- [`DELETE /orgs/:org/hooks/:hook_id`](/v3/orgs/hooks/#delete-an-organization-webhook) (:write)
|
||||
- [`POST /orgs/:org/hooks/:hook_id/pings`](/v3/orgs/hooks/#ping-an-organization-webhook) (:write)
|
||||
- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read)
|
||||
- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write)
|
||||
- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (:read)
|
||||
- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (:write)
|
||||
- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write)
|
||||
- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write)
|
||||
|
||||
_Teams_
|
||||
- [`DELETE /teams/:team_id/projects/:project_id`](/v3/teams/#remove-a-project-from-a-team) (:read)
|
||||
|
@ -659,14 +659,14 @@ _Teams_
|
|||
|
||||
### Permission on "pages"
|
||||
|
||||
- [`GET /repos/:owner/:repo/pages`](/v3/repos/pages/#get-a-github-pages-site) (:read)
|
||||
- [`POST /repos/:owner/:repo/pages`](/v3/repos/pages/#create-a-github-pages-site) (:write)
|
||||
- [`PUT /repos/:owner/:repo/pages`](/v3/repos/pages/#update-information-about-a-github-pages-site) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/pages`](/v3/repos/pages/#delete-a-github-pages-site) (:write)
|
||||
- [`GET /repos/:owner/:repo/pages/builds`](/v3/repos/pages/#list-github-pages-builds) (:read)
|
||||
- [`POST /repos/:owner/:repo/pages/builds`](/v3/repos/pages/#request-a-github-pages-build) (:write)
|
||||
- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/v3/repos/pages/#get-github-pages-build) (:read)
|
||||
- [`GET /repos/:owner/:repo/pages/builds/latest`](/v3/repos/pages/#get-latest-pages-build) (:read)
|
||||
- [`GET /repos/:owner/:repo/pages`](/rest/reference/repos#get-a-github-pages-site) (:read)
|
||||
- [`POST /repos/:owner/:repo/pages`](/rest/reference/repos#create-a-github-pages-site) (:write)
|
||||
- [`PUT /repos/:owner/:repo/pages`](/rest/reference/repos#update-information-about-a-github-pages-site) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/pages`](/rest/reference/repos#delete-a-github-pages-site) (:write)
|
||||
- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/repos#list-github-pages-builds) (:read)
|
||||
- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/repos#request-a-github-pages-build) (:write)
|
||||
- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/repos#get-github-pages-build) (:read)
|
||||
- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/repos#get-latest-pages-build) (:read)
|
||||
|
||||
### Permission on "pull requests"
|
||||
|
||||
|
@ -844,9 +844,9 @@ _Teams_
|
|||
|
||||
### Permission on "starring"
|
||||
|
||||
- [`GET /user/starred/:owner/:repo`](/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user) (:read)
|
||||
- [`PUT /user/starred/:owner/:repo`](/v3/activity/starring/#star-a-repository-for-the-authenticated-user) (:write)
|
||||
- [`DELETE /user/starred/:owner/:repo`](/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user) (:write)
|
||||
- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read)
|
||||
- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write)
|
||||
- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write)
|
||||
|
||||
### Permission on "statuses"
|
||||
|
||||
|
|
|
@ -93,31 +93,6 @@ type AcceptTopicSuggestionPayload {
|
|||
topic: Topic
|
||||
}
|
||||
|
||||
"""
|
||||
The possible capabilities for action executions setting.
|
||||
"""
|
||||
enum ActionExecutionCapabilitySetting {
|
||||
"""
|
||||
All action executions are enabled.
|
||||
"""
|
||||
ALL_ACTIONS
|
||||
|
||||
"""
|
||||
All action executions are disabled.
|
||||
"""
|
||||
DISABLED
|
||||
|
||||
"""
|
||||
Only actions defined within the repo are allowed.
|
||||
"""
|
||||
LOCAL_ACTIONS_ONLY
|
||||
|
||||
"""
|
||||
Organization administrators action execution capabilities.
|
||||
"""
|
||||
NO_POLICY
|
||||
}
|
||||
|
||||
"""
|
||||
Represents an object which can take actions on GitHub. Typically a User or Bot.
|
||||
"""
|
||||
|
@ -8016,36 +7991,6 @@ type EnterpriseOutsideCollaboratorEdge {
|
|||
Enterprise information only visible to enterprise owners.
|
||||
"""
|
||||
type EnterpriseOwnerInfo {
|
||||
"""
|
||||
A list of enterprise organizations configured with the provided action execution capabilities setting value.
|
||||
"""
|
||||
actionExecutionCapabilitySettingOrganizations(
|
||||
"""
|
||||
Returns the elements in the list that come after the specified cursor.
|
||||
"""
|
||||
after: String
|
||||
|
||||
"""
|
||||
Returns the elements in the list that come before the specified cursor.
|
||||
"""
|
||||
before: String
|
||||
|
||||
"""
|
||||
Returns the first _n_ elements from the list.
|
||||
"""
|
||||
first: Int
|
||||
|
||||
"""
|
||||
Returns the last _n_ elements from the list.
|
||||
"""
|
||||
last: Int
|
||||
|
||||
"""
|
||||
Ordering options for organizations with this setting.
|
||||
"""
|
||||
orderBy: OrganizationOrder = {field: LOGIN, direction: ASC}
|
||||
): OrganizationConnection!
|
||||
|
||||
"""
|
||||
A list of all of the administrators for this enterprise.
|
||||
"""
|
||||
|
@ -15219,11 +15164,6 @@ type Mutation {
|
|||
"""
|
||||
updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload
|
||||
|
||||
"""
|
||||
Sets the action execution capability setting for an enterprise.
|
||||
"""
|
||||
updateEnterpriseActionExecutionCapabilitySetting(input: UpdateEnterpriseActionExecutionCapabilitySettingInput!): UpdateEnterpriseActionExecutionCapabilitySettingPayload
|
||||
|
||||
"""
|
||||
Updates the role of an enterprise administrator.
|
||||
"""
|
||||
|
@ -36067,46 +36007,6 @@ type UpdateCheckSuitePreferencesPayload {
|
|||
repository: Repository
|
||||
}
|
||||
|
||||
"""
|
||||
Autogenerated input type of UpdateEnterpriseActionExecutionCapabilitySetting
|
||||
"""
|
||||
input UpdateEnterpriseActionExecutionCapabilitySettingInput {
|
||||
"""
|
||||
The value for the action execution capability setting on the enterprise.
|
||||
"""
|
||||
capability: ActionExecutionCapabilitySetting!
|
||||
|
||||
"""
|
||||
A unique identifier for the client performing the mutation.
|
||||
"""
|
||||
clientMutationId: String
|
||||
|
||||
"""
|
||||
The ID of the enterprise on which to set the members can create repositories setting.
|
||||
"""
|
||||
enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"])
|
||||
}
|
||||
|
||||
"""
|
||||
Autogenerated return type of UpdateEnterpriseActionExecutionCapabilitySetting
|
||||
"""
|
||||
type UpdateEnterpriseActionExecutionCapabilitySettingPayload {
|
||||
"""
|
||||
A unique identifier for the client performing the mutation.
|
||||
"""
|
||||
clientMutationId: String
|
||||
|
||||
"""
|
||||
The enterprise with the updated action execution capability setting.
|
||||
"""
|
||||
enterprise: Enterprise
|
||||
|
||||
"""
|
||||
A message confirming the result of updating the action execution capability setting.
|
||||
"""
|
||||
message: String
|
||||
}
|
||||
|
||||
"""
|
||||
Autogenerated input type of UpdateEnterpriseAdministratorRole
|
||||
"""
|
||||
|
|
|
@ -1 +1 @@
|
|||
You can also use {% data variables.product.prodname_enterprise_api %} to manage global webhooks. For a complete list of actions, see "[Global webhooks](/v3/enterprise-admin/global_webhooks)."
|
||||
You can also use {% data variables.product.prodname_enterprise_api %} to manage global webhooks. For a complete list of actions, see "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks)."
|
||||
|
|
|
@ -1 +1 @@
|
|||
You can use {% data variables.product.prodname_dotcom %}'s API to import a project board. For more information, see "[importProject](/v4/mutation/importproject/)."
|
||||
You can use {% data variables.product.prodname_dotcom %}'s API to import a project board. For more information, see "[importProject](/graphql/reference/mutations#importproject/)."
|
||||
|
|
|
@ -1 +1 @@
|
|||
A deployment is created. {% data reusables.webhooks.action_type_desc %} For more information, see the "[deployment](/v3/repos/deployments/#list-deployments)" REST API.
|
||||
A deployment is created. {% data reusables.webhooks.action_type_desc %} For more information, see the "[deployment](/rest/reference/repos#list-deployments)" REST API.
|
||||
|
|
|
@ -1 +1 @@
|
|||
A deployment is created. {% data reusables.webhooks.action_type_desc %} For more information, see the "[deployment statuses](/v3/repos/deployments/#list-deployment-statuses)" REST API.
|
||||
A deployment is created. {% data reusables.webhooks.action_type_desc %} For more information, see the "[deployment statuses](/rest/reference/repos#list-deployment-statuses)" REST API.
|
||||
|
|
|
@ -1 +1 @@
|
|||
When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isnt stored so it isn't retrievable via the [Events API](/v3/activity/events/). You can trigger a `ping` again by calling the [Ping a repository webhook](/v3/repos/hooks/#ping-a-repository-webhook) endpoint.
|
||||
When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isnt stored so it isn't retrievable via the [Events API](/rest/reference/activity#ping-a-repository-webhook) endpoint.
|
||||
|
|
|
@ -1,3 +1,3 @@
|
|||
`changes[body][from]` |`string` | The previous version of the body if the action was `edited`.
|
||||
`changes[name][from]` |`string` | The previous version of the name if the action was `edited`.
|
||||
`release`|`object` | The [release](/v3/repos/releases/#get-a-release) object.
|
||||
`release`|`object` | The [release](/rest/reference/repos/#get-a-release) object.
|
||||
|
|
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
@ -4342,48 +4342,6 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "updateEnterpriseActionExecutionCapabilitySetting",
|
||||
"kind": "mutations",
|
||||
"id": "updateenterpriseactionexecutioncapabilitysetting",
|
||||
"href": "/graphql/reference/mutations#updateenterpriseactionexecutioncapabilitysetting",
|
||||
"description": "<p>Sets the action execution capability setting for an enterprise.</p>",
|
||||
"inputFields": [
|
||||
{
|
||||
"name": "input",
|
||||
"type": "UpdateEnterpriseActionExecutionCapabilitySettingInput!",
|
||||
"id": "updateenterpriseactionexecutioncapabilitysettinginput",
|
||||
"kind": "input-objects",
|
||||
"href": "/graphql/reference/input-objects#updateenterpriseactionexecutioncapabilitysettinginput"
|
||||
}
|
||||
],
|
||||
"returnFields": [
|
||||
{
|
||||
"name": "clientMutationId",
|
||||
"type": "String",
|
||||
"id": "string",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#string",
|
||||
"description": "<p>A unique identifier for the client performing the mutation.</p>"
|
||||
},
|
||||
{
|
||||
"name": "enterprise",
|
||||
"type": "Enterprise",
|
||||
"id": "enterprise",
|
||||
"kind": "objects",
|
||||
"href": "/graphql/reference/objects#enterprise",
|
||||
"description": "<p>The enterprise with the updated action execution capability setting.</p>"
|
||||
},
|
||||
{
|
||||
"name": "message",
|
||||
"type": "String",
|
||||
"id": "string",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#string",
|
||||
"description": "<p>A message confirming the result of updating the action execution capability setting.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "updateEnterpriseAdministratorRole",
|
||||
"kind": "mutations",
|
||||
|
@ -13992,66 +13950,6 @@
|
|||
"href": "/graphql/reference/objects#enterpriseownerinfo",
|
||||
"description": "<p>Enterprise information only visible to enterprise owners.</p>",
|
||||
"fields": [
|
||||
{
|
||||
"name": "actionExecutionCapabilitySettingOrganizations",
|
||||
"description": "<p>A list of enterprise organizations configured with the provided action execution capabilities setting value.</p>",
|
||||
"type": "OrganizationConnection!",
|
||||
"id": "organizationconnection",
|
||||
"kind": "objects",
|
||||
"href": "/graphql/reference/objects#organizationconnection",
|
||||
"arguments": [
|
||||
{
|
||||
"name": "after",
|
||||
"description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
|
||||
"type": {
|
||||
"name": "String",
|
||||
"id": "string",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "before",
|
||||
"description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
|
||||
"type": {
|
||||
"name": "String",
|
||||
"id": "string",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "first",
|
||||
"description": "<p>Returns the first <em>n</em> elements from the list.</p>",
|
||||
"type": {
|
||||
"name": "Int",
|
||||
"id": "int",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#int"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "last",
|
||||
"description": "<p>Returns the last <em>n</em> elements from the list.</p>",
|
||||
"type": {
|
||||
"name": "Int",
|
||||
"id": "int",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#int"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "orderBy",
|
||||
"description": "<p>Ordering options for organizations with this setting.</p>",
|
||||
"type": {
|
||||
"name": "OrganizationOrder",
|
||||
"id": "organizationorder",
|
||||
"kind": "input-objects",
|
||||
"href": "/graphql/reference/input-objects#organizationorder"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "admins",
|
||||
"description": "<p>A list of all of the administrators for this enterprise.</p>",
|
||||
|
@ -56813,31 +56711,6 @@
|
|||
}
|
||||
],
|
||||
"enums": [
|
||||
{
|
||||
"name": "ActionExecutionCapabilitySetting",
|
||||
"kind": "enums",
|
||||
"id": "actionexecutioncapabilitysetting",
|
||||
"href": "/graphql/reference/enums#actionexecutioncapabilitysetting",
|
||||
"description": "<p>The possible capabilities for action executions setting.</p>",
|
||||
"values": [
|
||||
{
|
||||
"name": "ALL_ACTIONS",
|
||||
"description": "<p>All action executions are enabled.</p>"
|
||||
},
|
||||
{
|
||||
"name": "DISABLED",
|
||||
"description": "<p>All action executions are disabled.</p>"
|
||||
},
|
||||
{
|
||||
"name": "LOCAL_ACTIONS_ONLY",
|
||||
"description": "<p>Only actions defined within the repo are allowed.</p>"
|
||||
},
|
||||
{
|
||||
"name": "NO_POLICY",
|
||||
"description": "<p>Organization administrators action execution capabilities.</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "AuditLogOrderField",
|
||||
"kind": "enums",
|
||||
|
@ -67358,40 +67231,6 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "UpdateEnterpriseActionExecutionCapabilitySettingInput",
|
||||
"kind": "inputObjects",
|
||||
"id": "updateenterpriseactionexecutioncapabilitysettinginput",
|
||||
"href": "/graphql/reference/input-objects#updateenterpriseactionexecutioncapabilitysettinginput",
|
||||
"description": "<p>Autogenerated input type of UpdateEnterpriseActionExecutionCapabilitySetting.</p>",
|
||||
"inputFields": [
|
||||
{
|
||||
"name": "capability",
|
||||
"description": "<p>The value for the action execution capability setting on the enterprise.</p>",
|
||||
"type": "ActionExecutionCapabilitySetting!",
|
||||
"id": "actionexecutioncapabilitysetting",
|
||||
"kind": "enums",
|
||||
"href": "/graphql/reference/enums#actionexecutioncapabilitysetting"
|
||||
},
|
||||
{
|
||||
"name": "clientMutationId",
|
||||
"description": "<p>A unique identifier for the client performing the mutation.</p>",
|
||||
"type": "String",
|
||||
"id": "string",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#string"
|
||||
},
|
||||
{
|
||||
"name": "enterpriseId",
|
||||
"description": "<p>The ID of the enterprise on which to set the members can create repositories setting.</p>",
|
||||
"type": "ID!",
|
||||
"id": "id",
|
||||
"kind": "scalars",
|
||||
"href": "/graphql/reference/scalars#id",
|
||||
"isDeprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "UpdateEnterpriseAdministratorRoleInput",
|
||||
"kind": "inputObjects",
|
||||
|
|
Загрузка…
Ссылка в новой задаче