@octokit/openapi 13.0.0 → 13.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "13.0.0",
4
+ "version": "13.2.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -4427,7 +4427,7 @@
4427
4427
  },
4428
4428
  "post": {
4429
4429
  "summary": "Create a new authorization",
4430
- "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on).",
4430
+ "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.8/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.",
4431
4431
  "tags": [
4432
4432
  "oauth-authorizations"
4433
4433
  ],
@@ -16760,7 +16760,7 @@
16760
16760
  },
16761
16761
  "post": {
16762
16762
  "summary": "Start an organization migration",
16763
- "description": "Initiates the generation of a migration archive.",
16763
+ "description": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.8/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage).\"",
16764
16764
  "tags": [
16765
16765
  "migrations"
16766
16766
  ],
@@ -16830,7 +16830,7 @@
16830
16830
  },
16831
16831
  "exclude": {
16832
16832
  "type": "array",
16833
- "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.",
16833
+ "description": "Exclude related items from being returned in the response in order to improve performance of the request.",
16834
16834
  "items": {
16835
16835
  "type": "string",
16836
16836
  "enum": [
@@ -23452,7 +23452,7 @@
23452
23452
  "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
23453
23453
  "post": {
23454
23454
  "summary": "Re-run a job from a workflow run",
23455
- "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
23455
+ "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
23456
23456
  "tags": [
23457
23457
  "actions"
23458
23458
  ],
@@ -24072,7 +24072,7 @@
24072
24072
  "/repos/{owner}/{repo}/actions/runners": {
24073
24073
  "get": {
24074
24074
  "summary": "List self-hosted runners for a repository",
24075
- "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24075
+ "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24076
24076
  "tags": [
24077
24077
  "actions"
24078
24078
  ],
@@ -24144,7 +24144,7 @@
24144
24144
  "/repos/{owner}/{repo}/actions/runners/downloads": {
24145
24145
  "get": {
24146
24146
  "summary": "List runner applications for a repository",
24147
- "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24147
+ "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24148
24148
  "tags": [
24149
24149
  "actions"
24150
24150
  ],
@@ -24193,7 +24193,7 @@
24193
24193
  "/repos/{owner}/{repo}/actions/runners/registration-token": {
24194
24194
  "post": {
24195
24195
  "summary": "Create a registration token for a repository",
24196
- "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```",
24196
+ "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```",
24197
24197
  "tags": [
24198
24198
  "actions"
24199
24199
  ],
@@ -24239,7 +24239,7 @@
24239
24239
  "/repos/{owner}/{repo}/actions/runners/remove-token": {
24240
24240
  "post": {
24241
24241
  "summary": "Create a remove token for a repository",
24242
- "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```",
24242
+ "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```",
24243
24243
  "tags": [
24244
24244
  "actions"
24245
24245
  ],
@@ -24285,7 +24285,7 @@
24285
24285
  "/repos/{owner}/{repo}/actions/runners/{runner_id}": {
24286
24286
  "get": {
24287
24287
  "summary": "Get a self-hosted runner for a repository",
24288
- "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24288
+ "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24289
24289
  "tags": [
24290
24290
  "actions"
24291
24291
  ],
@@ -24332,7 +24332,7 @@
24332
24332
  },
24333
24333
  "delete": {
24334
24334
  "summary": "Delete a self-hosted runner from a repository",
24335
- "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24335
+ "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24336
24336
  "tags": [
24337
24337
  "actions"
24338
24338
  ],
@@ -24369,7 +24369,7 @@
24369
24369
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
24370
24370
  "get": {
24371
24371
  "summary": "List labels for a self-hosted runner for a repository",
24372
- "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24372
+ "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24373
24373
  "tags": [
24374
24374
  "actions"
24375
24375
  ],
@@ -24407,7 +24407,7 @@
24407
24407
  },
24408
24408
  "post": {
24409
24409
  "summary": "Add custom labels to a self-hosted runner for a repository",
24410
- "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24410
+ "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24411
24411
  "tags": [
24412
24412
  "actions"
24413
24413
  ],
@@ -24482,7 +24482,7 @@
24482
24482
  },
24483
24483
  "put": {
24484
24484
  "summary": "Set custom labels for a self-hosted runner for a repository",
24485
- "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24485
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24486
24486
  "tags": [
24487
24487
  "actions"
24488
24488
  ],
@@ -24557,7 +24557,7 @@
24557
24557
  },
24558
24558
  "delete": {
24559
24559
  "summary": "Remove all custom labels from a self-hosted runner for a repository",
24560
- "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24560
+ "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24561
24561
  "tags": [
24562
24562
  "actions"
24563
24563
  ],
@@ -24597,7 +24597,7 @@
24597
24597
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
24598
24598
  "delete": {
24599
24599
  "summary": "Remove a custom label from a self-hosted runner for a repository",
24600
- "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24600
+ "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
24601
24601
  "tags": [
24602
24602
  "actions"
24603
24603
  ],
@@ -25140,7 +25140,7 @@
25140
25140
  "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
25141
25141
  "post": {
25142
25142
  "summary": "Cancel a workflow run",
25143
- "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
25143
+ "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
25144
25144
  "tags": [
25145
25145
  "actions"
25146
25146
  ],
@@ -25948,7 +25948,7 @@
25948
25948
  "/repos/{owner}/{repo}/actions/variables": {
25949
25949
  "get": {
25950
25950
  "summary": "List repository variables",
25951
- "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
25951
+ "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
25952
25952
  "tags": [
25953
25953
  "actions"
25954
25954
  ],
@@ -26018,7 +26018,7 @@
26018
26018
  },
26019
26019
  "post": {
26020
26020
  "summary": "Create a repository variable",
26021
- "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26021
+ "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26022
26022
  "tags": [
26023
26023
  "actions"
26024
26024
  ],
@@ -26096,7 +26096,7 @@
26096
26096
  "/repos/{owner}/{repo}/actions/variables/{name}": {
26097
26097
  "get": {
26098
26098
  "summary": "Get a repository variable",
26099
- "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26099
+ "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26100
26100
  "tags": [
26101
26101
  "actions"
26102
26102
  ],
@@ -26143,7 +26143,7 @@
26143
26143
  },
26144
26144
  "patch": {
26145
26145
  "summary": "Update a repository variable",
26146
- "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26146
+ "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26147
26147
  "tags": [
26148
26148
  "actions"
26149
26149
  ],
@@ -26206,7 +26206,7 @@
26206
26206
  },
26207
26207
  "delete": {
26208
26208
  "summary": "Delete a repository variable",
26209
- "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26209
+ "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
26210
26210
  "tags": [
26211
26211
  "actions"
26212
26212
  ],
@@ -30153,7 +30153,7 @@
30153
30153
  },
30154
30154
  "patch": {
30155
30155
  "summary": "Update a check run",
30156
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
30156
+ "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
30157
30157
  "tags": [
30158
30158
  "checks"
30159
30159
  ],
@@ -30826,7 +30826,7 @@
30826
30826
  "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
30827
30827
  "get": {
30828
30828
  "summary": "List check runs in a check suite",
30829
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
30829
+ "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.",
30830
30830
  "tags": [
30831
30831
  "checks"
30832
30832
  ],
@@ -33020,7 +33020,7 @@
33020
33020
  "/repos/{owner}/{repo}/commits/{ref}/check-runs": {
33021
33021
  "get": {
33022
33022
  "summary": "List check runs for a Git reference",
33023
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
33023
+ "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
33024
33024
  "tags": [
33025
33025
  "checks"
33026
33026
  ],
@@ -33123,7 +33123,7 @@
33123
33123
  "/repos/{owner}/{repo}/commits/{ref}/check-suites": {
33124
33124
  "get": {
33125
33125
  "summary": "List check suites for a Git reference",
33126
- "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
33126
+ "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.",
33127
33127
  "tags": [
33128
33128
  "checks"
33129
33129
  ],
@@ -35675,7 +35675,7 @@
35675
35675
  "content": {
35676
35676
  "application/json": {
35677
35677
  "schema": {
35678
- "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
35678
+ "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
35679
35679
  },
35680
35680
  "examples": {
35681
35681
  "example-wildcard": {
@@ -35732,7 +35732,7 @@
35732
35732
  "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
35733
35733
  "get": {
35734
35734
  "summary": "Get a deployment branch policy",
35735
- "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
35735
+ "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.",
35736
35736
  "tags": [
35737
35737
  "repos"
35738
35738
  ],
@@ -37219,7 +37219,7 @@
37219
37219
  "operationId": "repos/list-webhooks",
37220
37220
  "externalDocs": {
37221
37221
  "description": "API method documentation",
37222
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#list-repository-webhooks"
37222
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#list-repository-webhooks"
37223
37223
  },
37224
37224
  "parameters": [
37225
37225
  {
@@ -37266,8 +37266,8 @@
37266
37266
  "x-github": {
37267
37267
  "githubCloudOnly": false,
37268
37268
  "enabledForGitHubApps": true,
37269
- "category": "webhooks",
37270
- "subcategory": "repos"
37269
+ "category": "repos",
37270
+ "subcategory": "webhooks"
37271
37271
  },
37272
37272
  "x-octokit": {}
37273
37273
  },
@@ -37280,7 +37280,7 @@
37280
37280
  "operationId": "repos/create-webhook",
37281
37281
  "externalDocs": {
37282
37282
  "description": "API method documentation",
37283
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#create-a-repository-webhook"
37283
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#create-a-repository-webhook"
37284
37284
  },
37285
37285
  "parameters": [
37286
37286
  {
@@ -37403,8 +37403,8 @@
37403
37403
  "x-github": {
37404
37404
  "githubCloudOnly": false,
37405
37405
  "enabledForGitHubApps": true,
37406
- "category": "webhooks",
37407
- "subcategory": "repos"
37406
+ "category": "repos",
37407
+ "subcategory": "webhooks"
37408
37408
  },
37409
37409
  "x-octokit": {}
37410
37410
  }
@@ -37419,7 +37419,7 @@
37419
37419
  "operationId": "repos/get-webhook",
37420
37420
  "externalDocs": {
37421
37421
  "description": "API method documentation",
37422
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#get-a-repository-webhook"
37422
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-repository-webhook"
37423
37423
  },
37424
37424
  "parameters": [
37425
37425
  {
@@ -37455,8 +37455,8 @@
37455
37455
  "x-github": {
37456
37456
  "githubCloudOnly": false,
37457
37457
  "enabledForGitHubApps": true,
37458
- "category": "webhooks",
37459
- "subcategory": "repos"
37458
+ "category": "repos",
37459
+ "subcategory": "webhooks"
37460
37460
  },
37461
37461
  "x-octokit": {}
37462
37462
  },
@@ -37469,7 +37469,7 @@
37469
37469
  "operationId": "repos/update-webhook",
37470
37470
  "externalDocs": {
37471
37471
  "description": "API method documentation",
37472
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#update-a-repository-webhook"
37472
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#update-a-repository-webhook"
37473
37473
  },
37474
37474
  "parameters": [
37475
37475
  {
@@ -37588,8 +37588,8 @@
37588
37588
  "x-github": {
37589
37589
  "githubCloudOnly": false,
37590
37590
  "enabledForGitHubApps": true,
37591
- "category": "webhooks",
37592
- "subcategory": "repos"
37591
+ "category": "repos",
37592
+ "subcategory": "webhooks"
37593
37593
  },
37594
37594
  "x-octokit": {}
37595
37595
  },
@@ -37602,7 +37602,7 @@
37602
37602
  "operationId": "repos/delete-webhook",
37603
37603
  "externalDocs": {
37604
37604
  "description": "API method documentation",
37605
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#delete-a-repository-webhook"
37605
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#delete-a-repository-webhook"
37606
37606
  },
37607
37607
  "parameters": [
37608
37608
  {
@@ -37626,8 +37626,8 @@
37626
37626
  "x-github": {
37627
37627
  "githubCloudOnly": false,
37628
37628
  "enabledForGitHubApps": true,
37629
- "category": "webhooks",
37630
- "subcategory": "repos"
37629
+ "category": "repos",
37630
+ "subcategory": "webhooks"
37631
37631
  },
37632
37632
  "x-octokit": {}
37633
37633
  }
@@ -37642,7 +37642,7 @@
37642
37642
  "operationId": "repos/get-webhook-config-for-repo",
37643
37643
  "externalDocs": {
37644
37644
  "description": "API method documentation",
37645
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
37645
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
37646
37646
  },
37647
37647
  "parameters": [
37648
37648
  {
@@ -37675,8 +37675,8 @@
37675
37675
  "x-github": {
37676
37676
  "githubCloudOnly": false,
37677
37677
  "enabledForGitHubApps": true,
37678
- "category": "webhooks",
37679
- "subcategory": "repo-config"
37678
+ "category": "repos",
37679
+ "subcategory": "webhooks"
37680
37680
  },
37681
37681
  "x-octokit": {}
37682
37682
  },
@@ -37689,7 +37689,7 @@
37689
37689
  "operationId": "repos/update-webhook-config-for-repo",
37690
37690
  "externalDocs": {
37691
37691
  "description": "API method documentation",
37692
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
37692
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
37693
37693
  },
37694
37694
  "parameters": [
37695
37695
  {
@@ -37756,8 +37756,8 @@
37756
37756
  "x-github": {
37757
37757
  "githubCloudOnly": false,
37758
37758
  "enabledForGitHubApps": true,
37759
- "category": "webhooks",
37760
- "subcategory": "repo-config"
37759
+ "category": "repos",
37760
+ "subcategory": "webhooks"
37761
37761
  },
37762
37762
  "x-octokit": {}
37763
37763
  }
@@ -37772,7 +37772,7 @@
37772
37772
  "operationId": "repos/list-webhook-deliveries",
37773
37773
  "externalDocs": {
37774
37774
  "description": "API method documentation",
37775
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
37775
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
37776
37776
  },
37777
37777
  "parameters": [
37778
37778
  {
@@ -37828,8 +37828,8 @@
37828
37828
  "x-github": {
37829
37829
  "githubCloudOnly": false,
37830
37830
  "enabledForGitHubApps": true,
37831
- "category": "webhooks",
37832
- "subcategory": "repo-deliveries"
37831
+ "category": "repos",
37832
+ "subcategory": "webhooks"
37833
37833
  },
37834
37834
  "x-octokit": {}
37835
37835
  }
@@ -37844,7 +37844,7 @@
37844
37844
  "operationId": "repos/get-webhook-delivery",
37845
37845
  "externalDocs": {
37846
37846
  "description": "API method documentation",
37847
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
37847
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
37848
37848
  },
37849
37849
  "parameters": [
37850
37850
  {
@@ -37886,8 +37886,8 @@
37886
37886
  "x-github": {
37887
37887
  "githubCloudOnly": false,
37888
37888
  "enabledForGitHubApps": true,
37889
- "category": "webhooks",
37890
- "subcategory": "repo-deliveries"
37889
+ "category": "repos",
37890
+ "subcategory": "webhooks"
37891
37891
  },
37892
37892
  "x-octokit": {}
37893
37893
  }
@@ -37902,7 +37902,7 @@
37902
37902
  "operationId": "repos/redeliver-webhook-delivery",
37903
37903
  "externalDocs": {
37904
37904
  "description": "API method documentation",
37905
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
37905
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
37906
37906
  },
37907
37907
  "parameters": [
37908
37908
  {
@@ -37932,8 +37932,8 @@
37932
37932
  "x-github": {
37933
37933
  "githubCloudOnly": false,
37934
37934
  "enabledForGitHubApps": true,
37935
- "category": "webhooks",
37936
- "subcategory": "repo-deliveries"
37935
+ "category": "repos",
37936
+ "subcategory": "webhooks"
37937
37937
  },
37938
37938
  "x-octokit": {}
37939
37939
  }
@@ -37948,7 +37948,7 @@
37948
37948
  "operationId": "repos/ping-webhook",
37949
37949
  "externalDocs": {
37950
37950
  "description": "API method documentation",
37951
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#ping-a-repository-webhook"
37951
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#ping-a-repository-webhook"
37952
37952
  },
37953
37953
  "parameters": [
37954
37954
  {
@@ -37972,8 +37972,8 @@
37972
37972
  "x-github": {
37973
37973
  "githubCloudOnly": false,
37974
37974
  "enabledForGitHubApps": true,
37975
- "category": "webhooks",
37976
- "subcategory": "repos"
37975
+ "category": "repos",
37976
+ "subcategory": "webhooks"
37977
37977
  },
37978
37978
  "x-octokit": {}
37979
37979
  }
@@ -37988,7 +37988,7 @@
37988
37988
  "operationId": "repos/test-push-webhook",
37989
37989
  "externalDocs": {
37990
37990
  "description": "API method documentation",
37991
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#test-the-push-repository-webhook"
37991
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#test-the-push-repository-webhook"
37992
37992
  },
37993
37993
  "parameters": [
37994
37994
  {
@@ -38012,8 +38012,8 @@
38012
38012
  "x-github": {
38013
38013
  "githubCloudOnly": false,
38014
38014
  "enabledForGitHubApps": true,
38015
- "category": "webhooks",
38016
- "subcategory": "repos"
38015
+ "category": "repos",
38016
+ "subcategory": "webhooks"
38017
38017
  },
38018
38018
  "x-octokit": {}
38019
38019
  }
@@ -41410,6 +41410,9 @@
41410
41410
  }
41411
41411
  }
41412
41412
  }
41413
+ },
41414
+ "404": {
41415
+ "$ref": "#/components/responses/not_found"
41413
41416
  }
41414
41417
  },
41415
41418
  "x-github": {
@@ -43787,7 +43790,7 @@
43787
43790
  "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
43788
43791
  "get": {
43789
43792
  "summary": "List reactions for a pull request review comment",
43790
- "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/pulls/comments#get-a-review-comment-for-a-pull-request).",
43793
+ "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
43791
43794
  "tags": [
43792
43795
  "reactions"
43793
43796
  ],
@@ -49269,7 +49272,7 @@
49269
49272
  "/repositories/{repository_id}/environments/{environment_name}/variables": {
49270
49273
  "get": {
49271
49274
  "summary": "List environment variables",
49272
- "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49275
+ "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49273
49276
  "tags": [
49274
49277
  "actions"
49275
49278
  ],
@@ -49339,7 +49342,7 @@
49339
49342
  },
49340
49343
  "post": {
49341
49344
  "summary": "Create an environment variable",
49342
- "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49345
+ "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49343
49346
  "tags": [
49344
49347
  "actions"
49345
49348
  ],
@@ -49417,7 +49420,7 @@
49417
49420
  "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
49418
49421
  "get": {
49419
49422
  "summary": "Get an environment variable",
49420
- "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49423
+ "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49421
49424
  "tags": [
49422
49425
  "actions"
49423
49426
  ],
@@ -49464,7 +49467,7 @@
49464
49467
  },
49465
49468
  "patch": {
49466
49469
  "summary": "Update an environment variable",
49467
- "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49470
+ "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49468
49471
  "tags": [
49469
49472
  "actions"
49470
49473
  ],
@@ -49527,7 +49530,7 @@
49527
49530
  },
49528
49531
  "delete": {
49529
49532
  "summary": "Delete an environment variable",
49530
- "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49533
+ "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.",
49531
49534
  "tags": [
49532
49535
  "actions"
49533
49536
  ],
@@ -73452,7 +73455,7 @@
73452
73455
  "pull-request-edited": {
73453
73456
  "post": {
73454
73457
  "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
73455
- "description": "The title or body of a pull request was edited.",
73458
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
73456
73459
  "operationId": "pull-request/edited",
73457
73460
  "externalDocs": {
73458
73461
  "url": "https://docs.github.com/enterprise-server@3.8/webhooks/webhook-events-and-payloads#pull_request"
@@ -81285,7 +81288,7 @@
81285
81288
  }
81286
81289
  },
81287
81290
  "x-github": {
81288
- "githubCloudOnly": false,
81291
+ "githubCloudOnly": true,
81289
81292
  "category": "webhooks",
81290
81293
  "subcategory": "user",
81291
81294
  "supported-webhook-types": [
@@ -81392,7 +81395,7 @@
81392
81395
  }
81393
81396
  },
81394
81397
  "x-github": {
81395
- "githubCloudOnly": false,
81398
+ "githubCloudOnly": true,
81396
81399
  "category": "webhooks",
81397
81400
  "subcategory": "user",
81398
81401
  "supported-webhook-types": [
@@ -94603,7 +94606,6 @@
94603
94606
  "forks",
94604
94607
  "forks_count",
94605
94608
  "git_url",
94606
- "has_downloads",
94607
94609
  "has_issues",
94608
94610
  "has_projects",
94609
94611
  "has_wiki",
@@ -94839,7 +94841,8 @@
94839
94841
  "enum": [
94840
94842
  "queued",
94841
94843
  "in_progress",
94842
- "completed"
94844
+ "completed",
94845
+ "waiting"
94843
94846
  ]
94844
94847
  },
94845
94848
  "conclusion": {
@@ -100578,6 +100581,20 @@
100578
100581
  }
100579
100582
  }
100580
100583
  },
100584
+ "deployment-branch-policy-name-pattern-with-type": {
100585
+ "title": "Deployment branch and tag policy name pattern",
100586
+ "type": "object",
100587
+ "properties": {
100588
+ "name": {
100589
+ "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
100590
+ "type": "string",
100591
+ "example": "release/*"
100592
+ }
100593
+ },
100594
+ "required": [
100595
+ "name"
100596
+ ]
100597
+ },
100581
100598
  "deployment-branch-policy-name-pattern": {
100582
100599
  "title": "Deployment branch policy name pattern",
100583
100600
  "type": "object",
@@ -113924,7 +113941,7 @@
113924
113941
  "format": "uri"
113925
113942
  },
113926
113943
  "conclusion": {
113927
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.",
113944
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.",
113928
113945
  "type": "string",
113929
113946
  "nullable": true,
113930
113947
  "enum": [
@@ -114705,7 +114722,7 @@
114705
114722
  "format": "uri"
114706
114723
  },
114707
114724
  "conclusion": {
114708
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
114725
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
114709
114726
  "type": "string",
114710
114727
  "nullable": true,
114711
114728
  "enum": [
@@ -115479,7 +115496,7 @@
115479
115496
  "format": "uri"
115480
115497
  },
115481
115498
  "conclusion": {
115482
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
115499
+ "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.",
115483
115500
  "type": "string",
115484
115501
  "nullable": true,
115485
115502
  "enum": [
@@ -115884,7 +115901,7 @@
115884
115901
  ]
115885
115902
  },
115886
115903
  "dismissed_reason": {
115887
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
115904
+ "description": "The reason for dismissing or closing the alert.",
115888
115905
  "type": "string",
115889
115906
  "nullable": true,
115890
115907
  "enum": [
@@ -116203,7 +116220,7 @@
116203
116220
  ]
116204
116221
  },
116205
116222
  "dismissed_reason": {
116206
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
116223
+ "description": "The reason for dismissing or closing the alert.",
116207
116224
  "type": "string",
116208
116225
  "nullable": true,
116209
116226
  "enum": [
@@ -116810,7 +116827,7 @@
116810
116827
  ]
116811
116828
  },
116812
116829
  "dismissed_reason": {
116813
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
116830
+ "description": "The reason for dismissing or closing the alert.",
116814
116831
  "type": "string",
116815
116832
  "nullable": true,
116816
116833
  "enum": [
@@ -123185,7 +123202,7 @@
123185
123202
  "format": "date-time"
123186
123203
  },
123187
123204
  "conclusion": {
123188
- "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
123205
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
123189
123206
  "type": "string",
123190
123207
  "nullable": true,
123191
123208
  "enum": [
@@ -147942,6 +147959,10 @@
147942
147959
  "type": "string",
147943
147960
  "format": "uri"
147944
147961
  },
147962
+ "has_discussions": {
147963
+ "description": "Whether the repository has discussions enabled.",
147964
+ "type": "boolean"
147965
+ },
147945
147966
  "has_downloads": {
147946
147967
  "description": "Whether downloads are enabled.",
147947
147968
  "type": "boolean",
@@ -148298,6 +148319,10 @@
148298
148319
  },
148299
148320
  "watchers_count": {
148300
148321
  "type": "integer"
148322
+ },
148323
+ "web_commit_signoff_required": {
148324
+ "description": "Whether to require commit signoff.",
148325
+ "type": "boolean"
148301
148326
  }
148302
148327
  },
148303
148328
  "required": [
@@ -269377,7 +269402,6 @@
269377
269402
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
269378
269403
  "svn_url": "https://svn.github.com/octocat/Hello-World",
269379
269404
  "homepage": "https://github.com",
269380
- "language": null,
269381
269405
  "forks_count": 9,
269382
269406
  "forks": 9,
269383
269407
  "stargazers_count": 80,
@@ -269762,7 +269786,6 @@
269762
269786
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
269763
269787
  "svn_url": "https://svn.github.com/octocat/Hello-World",
269764
269788
  "homepage": "https://github.com",
269765
- "language": null,
269766
269789
  "forks_count": 9,
269767
269790
  "stargazers_count": 80,
269768
269791
  "watchers_count": 80,
@@ -270439,7 +270462,7 @@
270439
270462
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
270440
270463
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
270441
270464
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
270442
- "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
270465
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
270443
270466
  "status": "completed",
270444
270467
  "conclusion": "success",
270445
270468
  "started_at": "2020-01-20T17:42:40Z",
@@ -271077,7 +271100,7 @@
271077
271100
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
271078
271101
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
271079
271102
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
271080
- "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
271103
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
271081
271104
  "status": "completed",
271082
271105
  "conclusion": "success",
271083
271106
  "started_at": "2020-01-20T17:42:40Z",
@@ -280866,16 +280889,10 @@
280866
280889
  "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
280867
280890
  "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
280868
280891
  "state": "open",
280869
- "resolution": null,
280870
- "resolved_at": null,
280871
- "resolved_by": null,
280872
280892
  "secret_type": "mailchimp_api_key",
280873
280893
  "secret_type_display_name": "Mailchimp API Key",
280874
280894
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
280875
- "push_protection_bypassed_by": null,
280876
- "push_protection_bypassed": false,
280877
- "push_protection_bypassed_at": null,
280878
- "resolution_comment": null
280895
+ "push_protection_bypassed": false
280879
280896
  }
280880
280897
  },
280881
280898
  "secret-scanning-alert-resolved": {
@@ -280912,8 +280929,6 @@
280912
280929
  "secret_type_display_name": "Mailchimp API Key",
280913
280930
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
280914
280931
  "push_protection_bypassed": false,
280915
- "push_protection_bypassed_by": null,
280916
- "push_protection_bypassed_at": null,
280917
280932
  "resolution_comment": "Example comment"
280918
280933
  }
280919
280934
  },
@@ -286317,7 +286332,7 @@
286317
286332
  },
286318
286333
  "hook-id": {
286319
286334
  "name": "hook_id",
286320
- "description": "The unique identifier of the hook.",
286335
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
286321
286336
  "in": "path",
286322
286337
  "required": true,
286323
286338
  "schema": {