@octokit/openapi 13.0.0 → 13.1.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.1.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
  ],
@@ -43787,7 +43787,7 @@
43787
43787
  "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
43788
43788
  "get": {
43789
43789
  "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).",
43790
+ "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
43791
  "tags": [
43792
43792
  "reactions"
43793
43793
  ],
@@ -49269,7 +49269,7 @@
49269
49269
  "/repositories/{repository_id}/environments/{environment_name}/variables": {
49270
49270
  "get": {
49271
49271
  "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.",
49272
+ "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
49273
  "tags": [
49274
49274
  "actions"
49275
49275
  ],
@@ -49339,7 +49339,7 @@
49339
49339
  },
49340
49340
  "post": {
49341
49341
  "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.",
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.\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
49343
  "tags": [
49344
49344
  "actions"
49345
49345
  ],
@@ -49417,7 +49417,7 @@
49417
49417
  "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
49418
49418
  "get": {
49419
49419
  "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.",
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.\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
49421
  "tags": [
49422
49422
  "actions"
49423
49423
  ],
@@ -49464,7 +49464,7 @@
49464
49464
  },
49465
49465
  "patch": {
49466
49466
  "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.",
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.\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
49468
  "tags": [
49469
49469
  "actions"
49470
49470
  ],
@@ -49527,7 +49527,7 @@
49527
49527
  },
49528
49528
  "delete": {
49529
49529
  "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.",
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.\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
49531
  "tags": [
49532
49532
  "actions"
49533
49533
  ],
@@ -81285,7 +81285,7 @@
81285
81285
  }
81286
81286
  },
81287
81287
  "x-github": {
81288
- "githubCloudOnly": false,
81288
+ "githubCloudOnly": true,
81289
81289
  "category": "webhooks",
81290
81290
  "subcategory": "user",
81291
81291
  "supported-webhook-types": [
@@ -81392,7 +81392,7 @@
81392
81392
  }
81393
81393
  },
81394
81394
  "x-github": {
81395
- "githubCloudOnly": false,
81395
+ "githubCloudOnly": true,
81396
81396
  "category": "webhooks",
81397
81397
  "subcategory": "user",
81398
81398
  "supported-webhook-types": [
@@ -94603,7 +94603,6 @@
94603
94603
  "forks",
94604
94604
  "forks_count",
94605
94605
  "git_url",
94606
- "has_downloads",
94607
94606
  "has_issues",
94608
94607
  "has_projects",
94609
94608
  "has_wiki",
@@ -100578,6 +100577,20 @@
100578
100577
  }
100579
100578
  }
100580
100579
  },
100580
+ "deployment-branch-policy-name-pattern-with-type": {
100581
+ "title": "Deployment branch and tag policy name pattern",
100582
+ "type": "object",
100583
+ "properties": {
100584
+ "name": {
100585
+ "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).",
100586
+ "type": "string",
100587
+ "example": "release/*"
100588
+ }
100589
+ },
100590
+ "required": [
100591
+ "name"
100592
+ ]
100593
+ },
100581
100594
  "deployment-branch-policy-name-pattern": {
100582
100595
  "title": "Deployment branch policy name pattern",
100583
100596
  "type": "object",
@@ -113924,7 +113937,7 @@
113924
113937
  "format": "uri"
113925
113938
  },
113926
113939
  "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`.",
113940
+ "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
113941
  "type": "string",
113929
113942
  "nullable": true,
113930
113943
  "enum": [
@@ -114705,7 +114718,7 @@
114705
114718
  "format": "uri"
114706
114719
  },
114707
114720
  "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.",
114721
+ "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
114722
  "type": "string",
114710
114723
  "nullable": true,
114711
114724
  "enum": [
@@ -115479,7 +115492,7 @@
115479
115492
  "format": "uri"
115480
115493
  },
115481
115494
  "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.",
115495
+ "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
115496
  "type": "string",
115484
115497
  "nullable": true,
115485
115498
  "enum": [
@@ -115884,7 +115897,7 @@
115884
115897
  ]
115885
115898
  },
115886
115899
  "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`.",
115900
+ "description": "The reason for dismissing or closing the alert.",
115888
115901
  "type": "string",
115889
115902
  "nullable": true,
115890
115903
  "enum": [
@@ -116203,7 +116216,7 @@
116203
116216
  ]
116204
116217
  },
116205
116218
  "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`.",
116219
+ "description": "The reason for dismissing or closing the alert.",
116207
116220
  "type": "string",
116208
116221
  "nullable": true,
116209
116222
  "enum": [
@@ -116810,7 +116823,7 @@
116810
116823
  ]
116811
116824
  },
116812
116825
  "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`.",
116826
+ "description": "The reason for dismissing or closing the alert.",
116814
116827
  "type": "string",
116815
116828
  "nullable": true,
116816
116829
  "enum": [
@@ -123185,7 +123198,7 @@
123185
123198
  "format": "date-time"
123186
123199
  },
123187
123200
  "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.",
123201
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
123189
123202
  "type": "string",
123190
123203
  "nullable": true,
123191
123204
  "enum": [
@@ -147942,6 +147955,10 @@
147942
147955
  "type": "string",
147943
147956
  "format": "uri"
147944
147957
  },
147958
+ "has_discussions": {
147959
+ "description": "Whether the repository has discussions enabled.",
147960
+ "type": "boolean"
147961
+ },
147945
147962
  "has_downloads": {
147946
147963
  "description": "Whether downloads are enabled.",
147947
147964
  "type": "boolean",
@@ -148298,6 +148315,10 @@
148298
148315
  },
148299
148316
  "watchers_count": {
148300
148317
  "type": "integer"
148318
+ },
148319
+ "web_commit_signoff_required": {
148320
+ "description": "Whether to require commit signoff.",
148321
+ "type": "boolean"
148301
148322
  }
148302
148323
  },
148303
148324
  "required": [
@@ -270439,7 +270460,7 @@
270439
270460
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
270440
270461
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
270441
270462
  "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",
270463
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
270443
270464
  "status": "completed",
270444
270465
  "conclusion": "success",
270445
270466
  "started_at": "2020-01-20T17:42:40Z",
@@ -271077,7 +271098,7 @@
271077
271098
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
271078
271099
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
271079
271100
  "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",
271101
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
271081
271102
  "status": "completed",
271082
271103
  "conclusion": "success",
271083
271104
  "started_at": "2020-01-20T17:42:40Z",
@@ -286317,7 +286338,7 @@
286317
286338
  },
286318
286339
  "hook-id": {
286319
286340
  "name": "hook_id",
286320
- "description": "The unique identifier of the hook.",
286341
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
286321
286342
  "in": "path",
286322
286343
  "required": true,
286323
286344
  "schema": {