@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.10/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.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/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.10/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.10/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.10/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.10/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.10/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.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/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.10/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.10/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.10/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.10/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.10/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
  ],
@@ -17716,7 +17716,7 @@
17716
17716
  },
17717
17717
  "post": {
17718
17718
  "summary": "Start an organization migration",
17719
- "description": "Initiates the generation of a migration archive.",
17719
+ "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.10/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).\"",
17720
17720
  "tags": [
17721
17721
  "migrations"
17722
17722
  ],
@@ -17786,7 +17786,7 @@
17786
17786
  },
17787
17787
  "exclude": {
17788
17788
  "type": "array",
17789
- "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\"`.",
17789
+ "description": "Exclude related items from being returned in the response in order to improve performance of the request.",
17790
17790
  "items": {
17791
17791
  "type": "string",
17792
17792
  "enum": [
@@ -25626,7 +25626,7 @@
25626
25626
  "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
25627
25627
  "post": {
25628
25628
  "summary": "Re-run a job from a workflow run",
25629
- "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.",
25629
+ "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.",
25630
25630
  "tags": [
25631
25631
  "actions"
25632
25632
  ],
@@ -25917,7 +25917,7 @@
25917
25917
  "/repos/{owner}/{repo}/actions/organization-variables": {
25918
25918
  "get": {
25919
25919
  "summary": "List repository organization variables",
25920
- "description": "Lists all organiation variables shared with 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.",
25920
+ "description": "Lists all organiation variables shared with 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.",
25921
25921
  "tags": [
25922
25922
  "actions"
25923
25923
  ],
@@ -26390,7 +26390,7 @@
26390
26390
  "/repos/{owner}/{repo}/actions/runners": {
26391
26391
  "get": {
26392
26392
  "summary": "List self-hosted runners for a repository",
26393
- "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.",
26393
+ "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.",
26394
26394
  "tags": [
26395
26395
  "actions"
26396
26396
  ],
@@ -26462,7 +26462,7 @@
26462
26462
  "/repos/{owner}/{repo}/actions/runners/downloads": {
26463
26463
  "get": {
26464
26464
  "summary": "List runner applications for a repository",
26465
- "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.",
26465
+ "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.",
26466
26466
  "tags": [
26467
26467
  "actions"
26468
26468
  ],
@@ -26511,7 +26511,7 @@
26511
26511
  "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": {
26512
26512
  "post": {
26513
26513
  "summary": "Create configuration for a just-in-time runner for a repository",
26514
- "description": "Generates a configuration that can be passed to the runner application at startup.\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.",
26514
+ "description": "Generates a configuration that can be passed to the runner application at startup.\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.",
26515
26515
  "tags": [
26516
26516
  "actions"
26517
26517
  ],
@@ -26605,7 +26605,7 @@
26605
26605
  "/repos/{owner}/{repo}/actions/runners/registration-token": {
26606
26606
  "post": {
26607
26607
  "summary": "Create a registration token for a repository",
26608
- "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```",
26608
+ "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```",
26609
26609
  "tags": [
26610
26610
  "actions"
26611
26611
  ],
@@ -26651,7 +26651,7 @@
26651
26651
  "/repos/{owner}/{repo}/actions/runners/remove-token": {
26652
26652
  "post": {
26653
26653
  "summary": "Create a remove token for a repository",
26654
- "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```",
26654
+ "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```",
26655
26655
  "tags": [
26656
26656
  "actions"
26657
26657
  ],
@@ -26697,7 +26697,7 @@
26697
26697
  "/repos/{owner}/{repo}/actions/runners/{runner_id}": {
26698
26698
  "get": {
26699
26699
  "summary": "Get a self-hosted runner for a repository",
26700
- "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.",
26700
+ "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.",
26701
26701
  "tags": [
26702
26702
  "actions"
26703
26703
  ],
@@ -26744,7 +26744,7 @@
26744
26744
  },
26745
26745
  "delete": {
26746
26746
  "summary": "Delete a self-hosted runner from a repository",
26747
- "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.",
26747
+ "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.",
26748
26748
  "tags": [
26749
26749
  "actions"
26750
26750
  ],
@@ -26781,7 +26781,7 @@
26781
26781
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
26782
26782
  "get": {
26783
26783
  "summary": "List labels for a self-hosted runner for a repository",
26784
- "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.",
26784
+ "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.",
26785
26785
  "tags": [
26786
26786
  "actions"
26787
26787
  ],
@@ -26819,7 +26819,7 @@
26819
26819
  },
26820
26820
  "post": {
26821
26821
  "summary": "Add custom labels to a self-hosted runner for a repository",
26822
- "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.",
26822
+ "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.",
26823
26823
  "tags": [
26824
26824
  "actions"
26825
26825
  ],
@@ -26894,7 +26894,7 @@
26894
26894
  },
26895
26895
  "put": {
26896
26896
  "summary": "Set custom labels for a self-hosted runner for a repository",
26897
- "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.",
26897
+ "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.",
26898
26898
  "tags": [
26899
26899
  "actions"
26900
26900
  ],
@@ -26969,7 +26969,7 @@
26969
26969
  },
26970
26970
  "delete": {
26971
26971
  "summary": "Remove all custom labels from a self-hosted runner for a repository",
26972
- "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.",
26972
+ "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.",
26973
26973
  "tags": [
26974
26974
  "actions"
26975
26975
  ],
@@ -27009,7 +27009,7 @@
27009
27009
  "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
27010
27010
  "delete": {
27011
27011
  "summary": "Remove a custom label from a self-hosted runner for a repository",
27012
- "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.",
27012
+ "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.",
27013
27013
  "tags": [
27014
27014
  "actions"
27015
27015
  ],
@@ -27552,7 +27552,7 @@
27552
27552
  "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
27553
27553
  "post": {
27554
27554
  "summary": "Cancel a workflow run",
27555
- "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.",
27555
+ "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.",
27556
27556
  "tags": [
27557
27557
  "actions"
27558
27558
  ],
@@ -28424,7 +28424,7 @@
28424
28424
  "/repos/{owner}/{repo}/actions/variables": {
28425
28425
  "get": {
28426
28426
  "summary": "List repository variables",
28427
- "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.",
28427
+ "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.",
28428
28428
  "tags": [
28429
28429
  "actions"
28430
28430
  ],
@@ -28494,7 +28494,7 @@
28494
28494
  },
28495
28495
  "post": {
28496
28496
  "summary": "Create a repository variable",
28497
- "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.",
28497
+ "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.",
28498
28498
  "tags": [
28499
28499
  "actions"
28500
28500
  ],
@@ -28572,7 +28572,7 @@
28572
28572
  "/repos/{owner}/{repo}/actions/variables/{name}": {
28573
28573
  "get": {
28574
28574
  "summary": "Get a repository variable",
28575
- "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.",
28575
+ "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.",
28576
28576
  "tags": [
28577
28577
  "actions"
28578
28578
  ],
@@ -28619,7 +28619,7 @@
28619
28619
  },
28620
28620
  "patch": {
28621
28621
  "summary": "Update a repository variable",
28622
- "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.",
28622
+ "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.",
28623
28623
  "tags": [
28624
28624
  "actions"
28625
28625
  ],
@@ -28682,7 +28682,7 @@
28682
28682
  },
28683
28683
  "delete": {
28684
28684
  "summary": "Delete a repository variable",
28685
- "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.",
28685
+ "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.",
28686
28686
  "tags": [
28687
28687
  "actions"
28688
28688
  ],
@@ -32662,7 +32662,7 @@
32662
32662
  },
32663
32663
  "patch": {
32664
32664
  "summary": "Update a check run",
32665
- "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.",
32665
+ "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.",
32666
32666
  "tags": [
32667
32667
  "checks"
32668
32668
  ],
@@ -33335,7 +33335,7 @@
33335
33335
  "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
33336
33336
  "get": {
33337
33337
  "summary": "List check runs in a check suite",
33338
- "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.",
33338
+ "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.",
33339
33339
  "tags": [
33340
33340
  "checks"
33341
33341
  ],
@@ -34202,7 +34202,7 @@
34202
34202
  }
34203
34203
  },
34204
34204
  "403": {
34205
- "$ref": "#/components/responses/code_scanning_forbidden_read"
34205
+ "$ref": "#/components/responses/code_scanning_forbidden_write"
34206
34206
  },
34207
34207
  "404": {
34208
34208
  "$ref": "#/components/responses/not_found"
@@ -35678,7 +35678,7 @@
35678
35678
  "/repos/{owner}/{repo}/commits/{ref}/check-runs": {
35679
35679
  "get": {
35680
35680
  "summary": "List check runs for a Git reference",
35681
- "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.",
35681
+ "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.10/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.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
35682
35682
  "tags": [
35683
35683
  "checks"
35684
35684
  ],
@@ -35781,7 +35781,7 @@
35781
35781
  "/repos/{owner}/{repo}/commits/{ref}/check-suites": {
35782
35782
  "get": {
35783
35783
  "summary": "List check suites for a Git reference",
35784
- "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.",
35784
+ "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`.",
35785
35785
  "tags": [
35786
35786
  "checks"
35787
35787
  ],
@@ -38389,7 +38389,7 @@
38389
38389
  "content": {
38390
38390
  "application/json": {
38391
38391
  "schema": {
38392
- "$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
38392
+ "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
38393
38393
  },
38394
38394
  "examples": {
38395
38395
  "example-wildcard": {
@@ -38446,7 +38446,7 @@
38446
38446
  "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
38447
38447
  "get": {
38448
38448
  "summary": "Get a deployment branch policy",
38449
- "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.",
38449
+ "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.",
38450
38450
  "tags": [
38451
38451
  "repos"
38452
38452
  ],
@@ -40252,7 +40252,7 @@
40252
40252
  "operationId": "repos/list-webhooks",
40253
40253
  "externalDocs": {
40254
40254
  "description": "API method documentation",
40255
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#list-repository-webhooks"
40255
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#list-repository-webhooks"
40256
40256
  },
40257
40257
  "parameters": [
40258
40258
  {
@@ -40299,8 +40299,8 @@
40299
40299
  "x-github": {
40300
40300
  "githubCloudOnly": false,
40301
40301
  "enabledForGitHubApps": true,
40302
- "category": "webhooks",
40303
- "subcategory": "repos"
40302
+ "category": "repos",
40303
+ "subcategory": "webhooks"
40304
40304
  },
40305
40305
  "x-octokit": {}
40306
40306
  },
@@ -40313,7 +40313,7 @@
40313
40313
  "operationId": "repos/create-webhook",
40314
40314
  "externalDocs": {
40315
40315
  "description": "API method documentation",
40316
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#create-a-repository-webhook"
40316
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#create-a-repository-webhook"
40317
40317
  },
40318
40318
  "parameters": [
40319
40319
  {
@@ -40436,8 +40436,8 @@
40436
40436
  "x-github": {
40437
40437
  "githubCloudOnly": false,
40438
40438
  "enabledForGitHubApps": true,
40439
- "category": "webhooks",
40440
- "subcategory": "repos"
40439
+ "category": "repos",
40440
+ "subcategory": "webhooks"
40441
40441
  },
40442
40442
  "x-octokit": {}
40443
40443
  }
@@ -40452,7 +40452,7 @@
40452
40452
  "operationId": "repos/get-webhook",
40453
40453
  "externalDocs": {
40454
40454
  "description": "API method documentation",
40455
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#get-a-repository-webhook"
40455
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-repository-webhook"
40456
40456
  },
40457
40457
  "parameters": [
40458
40458
  {
@@ -40488,8 +40488,8 @@
40488
40488
  "x-github": {
40489
40489
  "githubCloudOnly": false,
40490
40490
  "enabledForGitHubApps": true,
40491
- "category": "webhooks",
40492
- "subcategory": "repos"
40491
+ "category": "repos",
40492
+ "subcategory": "webhooks"
40493
40493
  },
40494
40494
  "x-octokit": {}
40495
40495
  },
@@ -40502,7 +40502,7 @@
40502
40502
  "operationId": "repos/update-webhook",
40503
40503
  "externalDocs": {
40504
40504
  "description": "API method documentation",
40505
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#update-a-repository-webhook"
40505
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#update-a-repository-webhook"
40506
40506
  },
40507
40507
  "parameters": [
40508
40508
  {
@@ -40621,8 +40621,8 @@
40621
40621
  "x-github": {
40622
40622
  "githubCloudOnly": false,
40623
40623
  "enabledForGitHubApps": true,
40624
- "category": "webhooks",
40625
- "subcategory": "repos"
40624
+ "category": "repos",
40625
+ "subcategory": "webhooks"
40626
40626
  },
40627
40627
  "x-octokit": {}
40628
40628
  },
@@ -40635,7 +40635,7 @@
40635
40635
  "operationId": "repos/delete-webhook",
40636
40636
  "externalDocs": {
40637
40637
  "description": "API method documentation",
40638
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#delete-a-repository-webhook"
40638
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#delete-a-repository-webhook"
40639
40639
  },
40640
40640
  "parameters": [
40641
40641
  {
@@ -40659,8 +40659,8 @@
40659
40659
  "x-github": {
40660
40660
  "githubCloudOnly": false,
40661
40661
  "enabledForGitHubApps": true,
40662
- "category": "webhooks",
40663
- "subcategory": "repos"
40662
+ "category": "repos",
40663
+ "subcategory": "webhooks"
40664
40664
  },
40665
40665
  "x-octokit": {}
40666
40666
  }
@@ -40675,7 +40675,7 @@
40675
40675
  "operationId": "repos/get-webhook-config-for-repo",
40676
40676
  "externalDocs": {
40677
40677
  "description": "API method documentation",
40678
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
40678
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
40679
40679
  },
40680
40680
  "parameters": [
40681
40681
  {
@@ -40708,8 +40708,8 @@
40708
40708
  "x-github": {
40709
40709
  "githubCloudOnly": false,
40710
40710
  "enabledForGitHubApps": true,
40711
- "category": "webhooks",
40712
- "subcategory": "repo-config"
40711
+ "category": "repos",
40712
+ "subcategory": "webhooks"
40713
40713
  },
40714
40714
  "x-octokit": {}
40715
40715
  },
@@ -40722,7 +40722,7 @@
40722
40722
  "operationId": "repos/update-webhook-config-for-repo",
40723
40723
  "externalDocs": {
40724
40724
  "description": "API method documentation",
40725
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
40725
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
40726
40726
  },
40727
40727
  "parameters": [
40728
40728
  {
@@ -40789,8 +40789,8 @@
40789
40789
  "x-github": {
40790
40790
  "githubCloudOnly": false,
40791
40791
  "enabledForGitHubApps": true,
40792
- "category": "webhooks",
40793
- "subcategory": "repo-config"
40792
+ "category": "repos",
40793
+ "subcategory": "webhooks"
40794
40794
  },
40795
40795
  "x-octokit": {}
40796
40796
  }
@@ -40805,7 +40805,7 @@
40805
40805
  "operationId": "repos/list-webhook-deliveries",
40806
40806
  "externalDocs": {
40807
40807
  "description": "API method documentation",
40808
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
40808
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
40809
40809
  },
40810
40810
  "parameters": [
40811
40811
  {
@@ -40861,8 +40861,8 @@
40861
40861
  "x-github": {
40862
40862
  "githubCloudOnly": false,
40863
40863
  "enabledForGitHubApps": true,
40864
- "category": "webhooks",
40865
- "subcategory": "repo-deliveries"
40864
+ "category": "repos",
40865
+ "subcategory": "webhooks"
40866
40866
  },
40867
40867
  "x-octokit": {}
40868
40868
  }
@@ -40877,7 +40877,7 @@
40877
40877
  "operationId": "repos/get-webhook-delivery",
40878
40878
  "externalDocs": {
40879
40879
  "description": "API method documentation",
40880
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
40880
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
40881
40881
  },
40882
40882
  "parameters": [
40883
40883
  {
@@ -40919,8 +40919,8 @@
40919
40919
  "x-github": {
40920
40920
  "githubCloudOnly": false,
40921
40921
  "enabledForGitHubApps": true,
40922
- "category": "webhooks",
40923
- "subcategory": "repo-deliveries"
40922
+ "category": "repos",
40923
+ "subcategory": "webhooks"
40924
40924
  },
40925
40925
  "x-octokit": {}
40926
40926
  }
@@ -40935,7 +40935,7 @@
40935
40935
  "operationId": "repos/redeliver-webhook-delivery",
40936
40936
  "externalDocs": {
40937
40937
  "description": "API method documentation",
40938
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
40938
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
40939
40939
  },
40940
40940
  "parameters": [
40941
40941
  {
@@ -40965,8 +40965,8 @@
40965
40965
  "x-github": {
40966
40966
  "githubCloudOnly": false,
40967
40967
  "enabledForGitHubApps": true,
40968
- "category": "webhooks",
40969
- "subcategory": "repo-deliveries"
40968
+ "category": "repos",
40969
+ "subcategory": "webhooks"
40970
40970
  },
40971
40971
  "x-octokit": {}
40972
40972
  }
@@ -40981,7 +40981,7 @@
40981
40981
  "operationId": "repos/ping-webhook",
40982
40982
  "externalDocs": {
40983
40983
  "description": "API method documentation",
40984
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#ping-a-repository-webhook"
40984
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#ping-a-repository-webhook"
40985
40985
  },
40986
40986
  "parameters": [
40987
40987
  {
@@ -41005,8 +41005,8 @@
41005
41005
  "x-github": {
41006
41006
  "githubCloudOnly": false,
41007
41007
  "enabledForGitHubApps": true,
41008
- "category": "webhooks",
41009
- "subcategory": "repos"
41008
+ "category": "repos",
41009
+ "subcategory": "webhooks"
41010
41010
  },
41011
41011
  "x-octokit": {}
41012
41012
  }
@@ -41021,7 +41021,7 @@
41021
41021
  "operationId": "repos/test-push-webhook",
41022
41022
  "externalDocs": {
41023
41023
  "description": "API method documentation",
41024
- "url": "https://docs.github.com/enterprise-server@3.10/rest/webhooks/repos#test-the-push-repository-webhook"
41024
+ "url": "https://docs.github.com/enterprise-server@3.10/rest/repos/webhooks#test-the-push-repository-webhook"
41025
41025
  },
41026
41026
  "parameters": [
41027
41027
  {
@@ -41045,8 +41045,8 @@
41045
41045
  "x-github": {
41046
41046
  "githubCloudOnly": false,
41047
41047
  "enabledForGitHubApps": true,
41048
- "category": "webhooks",
41049
- "subcategory": "repos"
41048
+ "category": "repos",
41049
+ "subcategory": "webhooks"
41050
41050
  },
41051
41051
  "x-octokit": {}
41052
41052
  }
@@ -44443,6 +44443,9 @@
44443
44443
  }
44444
44444
  }
44445
44445
  }
44446
+ },
44447
+ "404": {
44448
+ "$ref": "#/components/responses/not_found"
44446
44449
  }
44447
44450
  },
44448
44451
  "x-github": {
@@ -46820,7 +46823,7 @@
46820
46823
  "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
46821
46824
  "get": {
46822
46825
  "summary": "List reactions for a pull request review comment",
46823
- "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request).",
46826
+ "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
46824
46827
  "tags": [
46825
46828
  "reactions"
46826
46829
  ],
@@ -52411,7 +52414,7 @@
52411
52414
  "/repositories/{repository_id}/environments/{environment_name}/variables": {
52412
52415
  "get": {
52413
52416
  "summary": "List environment variables",
52414
- "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.",
52417
+ "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.",
52415
52418
  "tags": [
52416
52419
  "actions"
52417
52420
  ],
@@ -52481,7 +52484,7 @@
52481
52484
  },
52482
52485
  "post": {
52483
52486
  "summary": "Create an environment variable",
52484
- "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.",
52487
+ "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.",
52485
52488
  "tags": [
52486
52489
  "actions"
52487
52490
  ],
@@ -52559,7 +52562,7 @@
52559
52562
  "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": {
52560
52563
  "get": {
52561
52564
  "summary": "Get an environment variable",
52562
- "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.",
52565
+ "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.",
52563
52566
  "tags": [
52564
52567
  "actions"
52565
52568
  ],
@@ -52606,7 +52609,7 @@
52606
52609
  },
52607
52610
  "patch": {
52608
52611
  "summary": "Update an environment variable",
52609
- "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.",
52612
+ "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.",
52610
52613
  "tags": [
52611
52614
  "actions"
52612
52615
  ],
@@ -52669,7 +52672,7 @@
52669
52672
  },
52670
52673
  "delete": {
52671
52674
  "summary": "Delete an environment variable",
52672
- "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.",
52675
+ "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.",
52673
52676
  "tags": [
52674
52677
  "actions"
52675
52678
  ],
@@ -79104,7 +79107,7 @@
79104
79107
  "pull-request-edited": {
79105
79108
  "post": {
79106
79109
  "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.10/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.10/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.10/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.",
79107
- "description": "The title or body of a pull request was edited.",
79110
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
79108
79111
  "operationId": "pull-request/edited",
79109
79112
  "externalDocs": {
79110
79113
  "url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#pull_request"
@@ -86937,7 +86940,7 @@
86937
86940
  }
86938
86941
  },
86939
86942
  "x-github": {
86940
- "githubCloudOnly": false,
86943
+ "githubCloudOnly": true,
86941
86944
  "category": "webhooks",
86942
86945
  "subcategory": "user",
86943
86946
  "supported-webhook-types": [
@@ -87044,7 +87047,7 @@
87044
87047
  }
87045
87048
  },
87046
87049
  "x-github": {
87047
- "githubCloudOnly": false,
87050
+ "githubCloudOnly": true,
87048
87051
  "category": "webhooks",
87049
87052
  "subcategory": "user",
87050
87053
  "supported-webhook-types": [
@@ -101544,7 +101547,6 @@
101544
101547
  "forks",
101545
101548
  "forks_count",
101546
101549
  "git_url",
101547
- "has_downloads",
101548
101550
  "has_issues",
101549
101551
  "has_projects",
101550
101552
  "has_wiki",
@@ -101780,7 +101782,8 @@
101780
101782
  "enum": [
101781
101783
  "queued",
101782
101784
  "in_progress",
101783
- "completed"
101785
+ "completed",
101786
+ "waiting"
101784
101787
  ]
101785
101788
  },
101786
101789
  "conclusion": {
@@ -104982,7 +104985,7 @@
104982
104985
  ]
104983
104986
  },
104984
104987
  "languages": {
104985
- "description": "Languages to be analysed.",
104988
+ "description": "Languages to be analyzed.",
104986
104989
  "type": "array",
104987
104990
  "items": {
104988
104991
  "type": "string",
@@ -105038,7 +105041,7 @@
105038
105041
  ]
105039
105042
  },
105040
105043
  "languages": {
105041
- "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, and `ruby`.",
105044
+ "description": "CodeQL languages to be analyzed.",
105042
105045
  "type": "array",
105043
105046
  "items": {
105044
105047
  "type": "string",
@@ -107861,6 +107864,20 @@
107861
107864
  }
107862
107865
  }
107863
107866
  },
107867
+ "deployment-branch-policy-name-pattern-with-type": {
107868
+ "title": "Deployment branch and tag policy name pattern",
107869
+ "type": "object",
107870
+ "properties": {
107871
+ "name": {
107872
+ "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).",
107873
+ "type": "string",
107874
+ "example": "release/*"
107875
+ }
107876
+ },
107877
+ "required": [
107878
+ "name"
107879
+ ]
107880
+ },
107864
107881
  "deployment-branch-policy-name-pattern": {
107865
107882
  "title": "Deployment branch policy name pattern",
107866
107883
  "type": "object",
@@ -121546,7 +121563,7 @@
121546
121563
  "format": "uri"
121547
121564
  },
121548
121565
  "conclusion": {
121549
- "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`.",
121566
+ "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`.",
121550
121567
  "type": "string",
121551
121568
  "nullable": true,
121552
121569
  "enum": [
@@ -122327,7 +122344,7 @@
122327
122344
  "format": "uri"
122328
122345
  },
122329
122346
  "conclusion": {
122330
- "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.",
122347
+ "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.",
122331
122348
  "type": "string",
122332
122349
  "nullable": true,
122333
122350
  "enum": [
@@ -123101,7 +123118,7 @@
123101
123118
  "format": "uri"
123102
123119
  },
123103
123120
  "conclusion": {
123104
- "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.",
123121
+ "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.",
123105
123122
  "type": "string",
123106
123123
  "nullable": true,
123107
123124
  "enum": [
@@ -123506,7 +123523,7 @@
123506
123523
  ]
123507
123524
  },
123508
123525
  "dismissed_reason": {
123509
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
123526
+ "description": "The reason for dismissing or closing the alert.",
123510
123527
  "type": "string",
123511
123528
  "nullable": true,
123512
123529
  "enum": [
@@ -123825,7 +123842,7 @@
123825
123842
  ]
123826
123843
  },
123827
123844
  "dismissed_reason": {
123828
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
123845
+ "description": "The reason for dismissing or closing the alert.",
123829
123846
  "type": "string",
123830
123847
  "nullable": true,
123831
123848
  "enum": [
@@ -124432,7 +124449,7 @@
124432
124449
  ]
124433
124450
  },
124434
124451
  "dismissed_reason": {
124435
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
124452
+ "description": "The reason for dismissing or closing the alert.",
124436
124453
  "type": "string",
124437
124454
  "nullable": true,
124438
124455
  "enum": [
@@ -130853,7 +130870,7 @@
130853
130870
  "format": "date-time"
130854
130871
  },
130855
130872
  "conclusion": {
130856
- "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.",
130873
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
130857
130874
  "type": "string",
130858
130875
  "nullable": true,
130859
130876
  "enum": [
@@ -155682,6 +155699,10 @@
155682
155699
  "type": "string",
155683
155700
  "format": "uri"
155684
155701
  },
155702
+ "has_discussions": {
155703
+ "description": "Whether the repository has discussions enabled.",
155704
+ "type": "boolean"
155705
+ },
155685
155706
  "has_downloads": {
155686
155707
  "description": "Whether downloads are enabled.",
155687
155708
  "type": "boolean",
@@ -156038,6 +156059,10 @@
156038
156059
  },
156039
156060
  "watchers_count": {
156040
156061
  "type": "integer"
156062
+ },
156063
+ "web_commit_signoff_required": {
156064
+ "description": "Whether to require commit signoff.",
156065
+ "type": "boolean"
156041
156066
  }
156042
156067
  },
156043
156068
  "required": [
@@ -278141,7 +278166,6 @@
278141
278166
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
278142
278167
  "svn_url": "https://svn.github.com/octocat/Hello-World",
278143
278168
  "homepage": "https://github.com",
278144
- "language": null,
278145
278169
  "forks_count": 9,
278146
278170
  "forks": 9,
278147
278171
  "stargazers_count": 80,
@@ -278526,7 +278550,6 @@
278526
278550
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
278527
278551
  "svn_url": "https://svn.github.com/octocat/Hello-World",
278528
278552
  "homepage": "https://github.com",
278529
- "language": null,
278530
278553
  "forks_count": 9,
278531
278554
  "stargazers_count": 80,
278532
278555
  "watchers_count": 80,
@@ -279203,7 +279226,7 @@
279203
279226
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
279204
279227
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
279205
279228
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
279206
- "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
279229
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
279207
279230
  "status": "completed",
279208
279231
  "conclusion": "success",
279209
279232
  "started_at": "2020-01-20T17:42:40Z",
@@ -279877,7 +279900,7 @@
279877
279900
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
279878
279901
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
279879
279902
  "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
279880
- "html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
279903
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
279881
279904
  "status": "completed",
279882
279905
  "conclusion": "success",
279883
279906
  "started_at": "2020-01-20T17:42:40Z",
@@ -284967,7 +284990,6 @@
284967
284990
  "slug": "justice-league",
284968
284991
  "description": "A great team.",
284969
284992
  "privacy": "closed",
284970
- "notification_setting": "notifications_enabled",
284971
284993
  "permission": "admin",
284972
284994
  "members_url": "https://api.github.com/teams/1/members{/member}",
284973
284995
  "repositories_url": "https://api.github.com/teams/1/repos",
@@ -285045,7 +285067,6 @@
285045
285067
  "slug": "justice-league",
285046
285068
  "description": "A great team.",
285047
285069
  "privacy": "closed",
285048
- "notification_setting": "notifications_enabled",
285049
285070
  "permission": "admin",
285050
285071
  "members_url": "https://api.github.com/teams/1/members{/member}",
285051
285072
  "repositories_url": "https://api.github.com/teams/1/repos",
@@ -289771,16 +289792,10 @@
289771
289792
  "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
289772
289793
  "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
289773
289794
  "state": "open",
289774
- "resolution": null,
289775
- "resolved_at": null,
289776
- "resolved_by": null,
289777
289795
  "secret_type": "mailchimp_api_key",
289778
289796
  "secret_type_display_name": "Mailchimp API Key",
289779
289797
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
289780
- "push_protection_bypassed_by": null,
289781
- "push_protection_bypassed": false,
289782
- "push_protection_bypassed_at": null,
289783
- "resolution_comment": null
289798
+ "push_protection_bypassed": false
289784
289799
  }
289785
289800
  },
289786
289801
  "secret-scanning-alert-resolved": {
@@ -289817,8 +289832,6 @@
289817
289832
  "secret_type_display_name": "Mailchimp API Key",
289818
289833
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
289819
289834
  "push_protection_bypassed": false,
289820
- "push_protection_bypassed_by": null,
289821
- "push_protection_bypassed_at": null,
289822
289835
  "resolution_comment": "Example comment"
289823
289836
  }
289824
289837
  },
@@ -295511,7 +295524,7 @@
295511
295524
  },
295512
295525
  "hook-id": {
295513
295526
  "name": "hook_id",
295514
- "description": "The unique identifier of the hook.",
295527
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
295515
295528
  "in": "path",
295516
295529
  "required": true,
295517
295530
  "schema": {