diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md index ba4faa15b..8cd0c7a39 100644 --- a/docs/actions/createOrUpdateEnvironmentSecret.md +++ b/docs/actions/createOrUpdateEnvironmentSecret.md @@ -1,6 +1,6 @@ --- name: Create or update an environment secret -example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name }) +example: octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name, encrypted_value, key_id }) route: PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name} scope: actions type: API method @@ -88,6 +88,8 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({ repository_id, environment_name, secret_name, + encrypted_value, + key_id, }); ``` @@ -115,12 +117,12 @@ The name of the environment secret_name parameter -encrypted_valueno +encrypted_valueyes Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint. -key_idno +key_idyes ID of the key you used to encrypt the secret. diff --git a/docs/actions/setSelectedReposForOrgSecret.md b/docs/actions/setSelectedReposForOrgSecret.md index d437187b9..57ff0e661 100644 --- a/docs/actions/setSelectedReposForOrgSecret.md +++ b/docs/actions/setSelectedReposForOrgSecret.md @@ -1,6 +1,6 @@ --- name: Set selected repositories for an organization secret -example: octokit.rest.actions.setSelectedReposForOrgSecret({ org, secret_name }) +example: octokit.rest.actions.setSelectedReposForOrgSecret({ org, secret_name, selected_repository_ids }) route: PUT /orgs/{org}/actions/secrets/{secret_name}/repositories scope: actions type: API method @@ -14,6 +14,7 @@ Replaces all repositories for an organization secret when the `visibility` for r octokit.rest.actions.setSelectedReposForOrgSecret({ org, secret_name, + selected_repository_ids, }); ``` @@ -36,7 +37,7 @@ octokit.rest.actions.setSelectedReposForOrgSecret({ secret_name parameter -selected_repository_idsno +selected_repository_idsyes An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints. diff --git a/docs/apps/deleteAuthorization.md b/docs/apps/deleteAuthorization.md index f8a5bb3c2..dfcc9a9e4 100644 --- a/docs/apps/deleteAuthorization.md +++ b/docs/apps/deleteAuthorization.md @@ -1,6 +1,6 @@ --- name: Delete an app authorization -example: octokit.rest.apps.deleteAuthorization({ client_id }) +example: octokit.rest.apps.deleteAuthorization({ client_id, access_token }) route: DELETE /applications/{client_id}/grant scope: apps type: API method @@ -14,6 +14,7 @@ Deleting an OAuth application's grant will also delete all OAuth tokens associat ```js octokit.rest.apps.deleteAuthorization({ client_id, + access_token, }); ``` @@ -33,7 +34,7 @@ octokit.rest.apps.deleteAuthorization({ The client ID of your GitHub app. -access_tokenno +access_tokenyes The OAuth access token used to authenticate to the GitHub API. diff --git a/docs/codesOfConduct/getForRepo.md b/docs/codesOfConduct/getForRepo.md deleted file mode 100644 index 847fdc09b..000000000 --- a/docs/codesOfConduct/getForRepo.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Get the code of conduct for a repository -example: octokit.rest.codesOfConduct.getForRepo({ owner, repo }) -route: GET /repos/{owner}/{repo}/community/code_of_conduct -scope: codesOfConduct -type: API method ---- - -# Get the code of conduct for a repository - -Returns the contents of the repository's code of conduct file, if one is detected. - -A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. - -```js -octokit.rest.codesOfConduct.getForRepo({ - owner, - repo, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
owneryes - -
repoyes - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository). diff --git a/docs/repos/createDeployment.md b/docs/repos/createDeployment.md index d0164218b..71f779fc2 100644 --- a/docs/repos/createDeployment.md +++ b/docs/repos/createDeployment.md @@ -118,14 +118,12 @@ Short description of the deployment. transient_environmentno -Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` -**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. +Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` production_environmentno -Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. -**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. +Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. diff --git a/docs/repos/createDeploymentStatus.md b/docs/repos/createDeploymentStatus.md index 81ac89248..d42146e47 100644 --- a/docs/repos/createDeploymentStatus.md +++ b/docs/repos/createDeploymentStatus.md @@ -45,7 +45,7 @@ deployment_id parameter stateyes -The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. +The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. target_urlno @@ -55,8 +55,7 @@ The target URL to associate with this status. This URL should contain output to log_urlno -The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` -**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. +The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` descriptionno @@ -66,20 +65,17 @@ A short description of the status. The maximum description length is 140 charact environmentno -Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. +Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. environment_urlno -Sets the URL for accessing your environment. Default: `""` -**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. +Sets the URL for accessing your environment. Default: `""` auto_inactiveno -Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` -**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. -**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. +Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` diff --git a/docs/repos/get.md b/docs/repos/get.md index 2324cbdbf..27e659090 100644 --- a/docs/repos/get.md +++ b/docs/repos/get.md @@ -8,8 +8,6 @@ type: API method # Get a repository -When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. - The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. ```js diff --git a/package-lock.json b/package-lock.json index 2b6226757..ca431239f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^6.31.1", + "@octokit/types": "^6.31.2", "deprecation": "^2.3.1" }, "devDependencies": { @@ -2516,9 +2516,9 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "10.6.1", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.1.tgz", - "integrity": "sha512-53YKy8w8+sHQhUONhTiYt6MqNqPolejYr6rK/3VOevpORAIYGQEX2pmXnnhgdSsjHy176e5ZBgVt0ppOGziS7g==" + "version": "10.6.3", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.3.tgz", + "integrity": "sha512-D4WFg5dZHMsaPYlb18JsrMYEtlOwJckIuigKR1uqyplCSxBF80+5mXX0k+fd6NVqRPsnztoXvtyoyUYQkk87Rw==" }, "node_modules/@octokit/plugin-paginate-rest": { "version": "2.16.5", @@ -2592,11 +2592,11 @@ } }, "node_modules/@octokit/types": { - "version": "6.31.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.1.tgz", - "integrity": "sha512-xkF46eaYcpT8ieO78mZWhMq3bt37zIsP5BUkN+zWgX+mTYDB7jOtUP1MOxcSF8hhJhsjjlB1YDgQAhX0z0oqPw==", + "version": "6.31.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.2.tgz", + "integrity": "sha512-IxU79++1fj/1ZJ2S33iljQy/guydjztc8gqCHO7gSr5ss5hJEVqCPEI74mEerpPbDKMGUgTXTvNiphAXswE82A==", "dependencies": { - "@octokit/openapi-types": "^10.6.1" + "@octokit/openapi-types": "^10.6.3" } }, "node_modules/@pika/babel-plugin-esm-import-rewrite": { @@ -18955,9 +18955,9 @@ } }, "@octokit/openapi-types": { - "version": "10.6.1", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.1.tgz", - "integrity": "sha512-53YKy8w8+sHQhUONhTiYt6MqNqPolejYr6rK/3VOevpORAIYGQEX2pmXnnhgdSsjHy176e5ZBgVt0ppOGziS7g==" + "version": "10.6.3", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-10.6.3.tgz", + "integrity": "sha512-D4WFg5dZHMsaPYlb18JsrMYEtlOwJckIuigKR1uqyplCSxBF80+5mXX0k+fd6NVqRPsnztoXvtyoyUYQkk87Rw==" }, "@octokit/plugin-paginate-rest": { "version": "2.16.5", @@ -19023,11 +19023,11 @@ } }, "@octokit/types": { - "version": "6.31.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.1.tgz", - "integrity": "sha512-xkF46eaYcpT8ieO78mZWhMq3bt37zIsP5BUkN+zWgX+mTYDB7jOtUP1MOxcSF8hhJhsjjlB1YDgQAhX0z0oqPw==", + "version": "6.31.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.31.2.tgz", + "integrity": "sha512-IxU79++1fj/1ZJ2S33iljQy/guydjztc8gqCHO7gSr5ss5hJEVqCPEI74mEerpPbDKMGUgTXTvNiphAXswE82A==", "requires": { - "@octokit/openapi-types": "^10.6.1" + "@octokit/openapi-types": "^10.6.3" } }, "@pika/babel-plugin-esm-import-rewrite": { diff --git a/package.json b/package.json index 79ee09199..87e6a847c 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^6.31.1", + "@octokit/types": "^6.31.2", "deprecation": "^2.3.1" }, "devDependencies": { diff --git a/scripts/update-endpoints/fetch-json.js b/scripts/update-endpoints/fetch-json.js index bd0e38323..e6c58417b 100644 --- a/scripts/update-endpoints/fetch-json.js +++ b/scripts/update-endpoints/fetch-json.js @@ -20,6 +20,7 @@ const QUERY = ` url isDeprecated deprecationDate + removalDate description documentationUrl previews(required: true) { diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index ed2c1fdba..2861041f6 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -7,6 +7,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret", "previews": [], @@ -74,6 +75,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approve", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see [\"Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request", "previews": [], @@ -134,6 +136,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#cancel-a-workflow-run", "previews": [], @@ -190,6 +193,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret", "previews": [], @@ -239,7 +243,7 @@ "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -252,7 +256,7 @@ "description": "ID of the key you used to encrypt the secret.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -283,6 +287,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret", "previews": [], @@ -389,6 +394,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret", "previews": [], @@ -482,6 +488,7 @@ "url": "/orgs/{org}/actions/runners/registration-token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization", "previews": [], @@ -522,6 +529,7 @@ "url": "/repos/{owner}/{repo}/actions/runners/registration-token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `repo` scope to use this endpoint.\n\n#### Example using registration token\n \nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository", "previews": [], @@ -575,6 +583,7 @@ "url": "/orgs/{org}/actions/runners/remove-token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization", "previews": [], @@ -615,6 +624,7 @@ "url": "/repos/{owner}/{repo}/actions/runners/remove-token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\n#### Example using remove token\n \nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.\n\n```\n./config.sh remove --token TOKEN\n```", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository", "previews": [], @@ -668,6 +678,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event", "previews": [], @@ -763,6 +774,7 @@ "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-an-artifact", "previews": [], @@ -819,6 +831,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-an-environment-secret", "previews": [], @@ -877,6 +890,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-an-organization-secret", "previews": [], @@ -920,6 +934,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-repository-secret", "previews": [], @@ -976,6 +991,7 @@ "url": "/orgs/{org}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Forces the removal of a self-hosted runner from an organization. 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 `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization", "previews": [], @@ -1019,6 +1035,7 @@ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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`\nscope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository", "previews": [], @@ -1075,6 +1092,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-workflow-run", "previews": [], @@ -1131,6 +1149,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-workflow-run-logs", "previews": [], @@ -1187,6 +1206,7 @@ "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], @@ -1230,6 +1250,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-workflow", "previews": [], @@ -1286,6 +1307,7 @@ "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#download-an-artifact", "previews": [], @@ -1355,6 +1377,7 @@ "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run", "previews": [], @@ -1411,6 +1434,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-logs", "previews": [], @@ -1467,6 +1491,7 @@ "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], @@ -1510,6 +1535,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-workflow", "previews": [], @@ -1566,6 +1592,7 @@ "url": "/orgs/{org}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization", "previews": [], @@ -1606,6 +1633,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository", "previews": [], @@ -1659,6 +1687,7 @@ "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific artifact for a workflow run. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-artifact", "previews": [], @@ -1725,6 +1754,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone 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 `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-public-key", "previews": [], @@ -1778,6 +1808,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-environment-secret", "previews": [], @@ -1844,6 +1875,7 @@ "url": "/orgs/{org}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization", "previews": [], @@ -1884,6 +1916,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository", "previews": [], @@ -1937,6 +1970,7 @@ "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific job in a workflow run. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run", "previews": [], @@ -2003,6 +2037,7 @@ "url": "/orgs/{org}/actions/secrets/public-key", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-public-key", "previews": [], @@ -2043,6 +2078,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-an-organization-secret", "previews": [], @@ -2096,6 +2132,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run", "previews": [], @@ -2162,6 +2199,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository", "previews": [], @@ -2223,6 +2261,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/public-key", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone 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 `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-public-key", "previews": [], @@ -2276,6 +2315,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-secret", "previews": [], @@ -2342,6 +2382,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run", "previews": [], @@ -2408,6 +2449,7 @@ "url": "/orgs/{org}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", "previews": [], @@ -2461,6 +2503,7 @@ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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\nendpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", "previews": [], @@ -2527,6 +2570,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow", "previews": [], @@ -2593,6 +2637,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific workflow run. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run", "previews": [], @@ -2659,6 +2704,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage", "previews": [], @@ -2710,7 +2756,7 @@ "description": "Response", "examples": [ { - "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1},\"MACOS\":{\"total_ms\":240000,\"jobs\":4},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2}},\"run_duration_ms\":500000}" + "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}" } ] } @@ -2725,6 +2771,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage", "previews": [], @@ -2791,6 +2838,7 @@ "url": "/repos/{owner}/{repo}/actions/artifacts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all artifacts for a repository. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository", "previews": [], @@ -2870,6 +2918,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets", "previews": [], @@ -2949,6 +2998,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists jobs for a workflow run. Anyone 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. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run", "previews": [], @@ -3054,6 +3104,7 @@ "url": "/orgs/{org}/actions/secrets", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets", "previews": [], @@ -3120,6 +3171,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-secrets", "previews": [], @@ -3199,6 +3251,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the workflows in a repository. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-workflows", "previews": [], @@ -3278,6 +3331,7 @@ "url": "/orgs/{org}/actions/runners/downloads", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization", "previews": [], @@ -3318,6 +3372,7 @@ "url": "/repos/{owner}/{repo}/actions/runners/downloads", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository", "previews": [], @@ -3371,6 +3426,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret", "previews": [], @@ -3450,6 +3506,7 @@ "url": "/orgs/{org}/actions/permissions/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], @@ -3516,6 +3573,7 @@ "url": "/orgs/{org}/actions/runners", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization", "previews": [], @@ -3582,6 +3640,7 @@ "url": "/repos/{owner}/{repo}/actions/runners", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository", "previews": [], @@ -3661,6 +3720,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists artifacts for a workflow run. Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts", "previews": [], @@ -3753,6 +3813,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs", "previews": [], @@ -3924,6 +3985,7 @@ "url": "/repos/{owner}/{repo}/actions/runs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\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.", "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository", "previews": [], @@ -4082,6 +4144,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "isDeprecated": true, "deprecationDate": "2021-09-14", + "removalDate": null, "description": "**Deprecation Notice:** This endpoint is deprecated.\nWe recommend migrating your existing code to use the new [retry workflow](https://docs.github.com/rest/reference/actions#retry-a-workflow) endpoint.\n\nRe-runs your workflow run using its `id`. You must authenticate using\nan access token with the `repo` scope to use this endpoint. GitHub Apps must have\nthe `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow", "previews": [], @@ -4138,6 +4201,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret", "previews": [], @@ -4205,6 +4269,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/retry", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Retry your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#retry-a-workflow", "previews": [], @@ -4261,6 +4326,7 @@ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run", "previews": [], @@ -4366,6 +4432,7 @@ "url": "/orgs/{org}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization", "previews": [], @@ -4435,6 +4502,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository", "previews": [], @@ -4517,6 +4585,7 @@ "url": "/orgs/{org}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization", "previews": [], @@ -4573,6 +4642,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository", "previews": [], @@ -4642,6 +4712,7 @@ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret", "previews": [], @@ -4678,7 +4749,7 @@ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -4698,6 +4769,7 @@ "url": "/orgs/{org}/actions/permissions/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], @@ -4741,6 +4813,7 @@ "url": "/user/starred/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", "previews": [], @@ -4802,6 +4875,7 @@ "url": "/repos/{owner}/{repo}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/reference/activity#set-a-repository-subscription).", "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-repository-subscription", "previews": [], @@ -4845,6 +4919,7 @@ "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", "documentationUrl": "https://docs.github.com/rest/reference/activity#delete-a-thread-subscription", "previews": [], @@ -4884,6 +4959,7 @@ "url": "/feeds", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "documentationUrl": "https://docs.github.com/rest/reference/activity#get-feeds", "previews": [], @@ -4910,6 +4986,7 @@ "url": "/repos/{owner}/{repo}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-repository-subscription", "previews": [], @@ -4969,6 +5046,7 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread", "previews": [], @@ -5016,6 +5094,7 @@ "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", "previews": [], @@ -5063,6 +5142,7 @@ "url": "/users/{username}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user", "previews": [], @@ -5119,6 +5199,7 @@ "url": "/notifications", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all notifications for the current user, sorted by most recently updated.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user", "previews": [], @@ -5232,6 +5313,7 @@ "url": "/users/{username}/events/orgs/{org}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user", "previews": [], @@ -5301,6 +5383,7 @@ "url": "/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events", "previews": [], @@ -5349,6 +5432,7 @@ "url": "/networks/{owner}/{repo}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories", "previews": [], @@ -5424,6 +5508,7 @@ "url": "/users/{username}/events/public", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-user", "previews": [], @@ -5480,6 +5565,7 @@ "url": "/orgs/{org}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-organization-events", "previews": [], @@ -5536,6 +5622,7 @@ "url": "/users/{username}/received_events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user", "previews": [], @@ -5592,6 +5679,7 @@ "url": "/users/{username}/received_events/public", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user", "previews": [], @@ -5648,6 +5736,7 @@ "url": "/repos/{owner}/{repo}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-events", "previews": [], @@ -5717,6 +5806,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all notifications for the current user.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", "previews": [], @@ -5848,6 +5938,7 @@ "url": "/user/starred", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories the authenticated user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", "previews": [], @@ -5943,6 +6034,7 @@ "url": "/users/{username}/starred", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories a user has starred.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user", "previews": [], @@ -6035,6 +6127,7 @@ "url": "/users/{username}/subscriptions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories a user is watching.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user", "previews": [], @@ -6101,6 +6194,7 @@ "url": "/repos/{owner}/{repo}/stargazers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people that have starred the repository.\n\nYou can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-stargazers", "previews": [], @@ -6184,6 +6278,7 @@ "url": "/user/subscriptions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories the authenticated user is watching.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", "previews": [], @@ -6244,6 +6339,7 @@ "url": "/repos/{owner}/{repo}/subscribers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people watching the specified repository.", "documentationUrl": "https://docs.github.com/rest/reference/activity#list-watchers", "previews": [], @@ -6323,6 +6419,7 @@ "url": "/notifications", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-notifications-as-read", "previews": [], @@ -6376,6 +6473,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read", "previews": [], @@ -6435,6 +6533,7 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read", "previews": [], @@ -6469,6 +6568,7 @@ "url": "/repos/{owner}/{repo}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription) completely.", "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-repository-subscription", "previews": [], @@ -6548,6 +6648,7 @@ "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/activity#set-a-thread-subscription", "previews": [], @@ -6608,6 +6709,7 @@ "url": "/user/starred/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user", "previews": [], @@ -6661,6 +6763,7 @@ "url": "/user/starred/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", "previews": [], @@ -6714,6 +6817,7 @@ "url": "/user/installations/{installation_id}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation", "previews": [], @@ -6762,6 +6866,7 @@ "url": "/applications/{client_id}/token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", "documentationUrl": "https://docs.github.com/rest/reference/apps#check-a-token", "previews": [], @@ -6817,6 +6922,7 @@ "url": "/content_references/{content_reference_id}/attachments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", "previews": [{ "name": "corsair" }], @@ -6893,6 +6999,7 @@ "url": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", "previews": [{ "name": "corsair" }], @@ -6995,6 +7102,7 @@ "url": "/app-manifests/{code}/conversions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest", "previews": [], @@ -7037,6 +7145,7 @@ "url": "/app/installations/{installation_id}/access_tokens", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app", "previews": [], @@ -7532,6 +7641,7 @@ "url": "/applications/{client_id}/grant", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "documentationUrl": "https://docs.github.com/rest/reference/apps#delete-an-app-authorization", "previews": [], @@ -7555,7 +7665,7 @@ "description": "The OAuth access token used to authenticate to the GitHub API.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -7578,6 +7688,7 @@ "url": "/app/installations/{installation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app", "previews": [], @@ -7611,6 +7722,7 @@ "url": "/applications/{client_id}/token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", "documentationUrl": "https://docs.github.com/rest/reference/apps#delete-an-app-token", "previews": [], @@ -7657,6 +7769,7 @@ "url": "/app", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-the-authenticated-app", "previews": [], @@ -7683,6 +7796,7 @@ "url": "/apps/{app_slug}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps/#get-an-app", "previews": [], @@ -7726,6 +7840,7 @@ "url": "/app/installations/{installation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app", "previews": [], @@ -7768,6 +7883,7 @@ "url": "/orgs/{org}/installation", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app", "previews": [], @@ -7808,6 +7924,7 @@ "url": "/repos/{owner}/{repo}/installation", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app", "previews": [], @@ -7863,6 +7980,7 @@ "url": "/marketplace_listing/accounts/{account_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account", "previews": [], @@ -7913,6 +8031,7 @@ "url": "/marketplace_listing/stubbed/accounts/{account_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed", "previews": [], @@ -7963,6 +8082,7 @@ "url": "/users/{username}/installation", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app", "previews": [], @@ -8003,6 +8123,7 @@ "url": "/app/hook/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app", "previews": [], @@ -8029,6 +8150,7 @@ "url": "/app/hook/deliveries/{delivery_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook", "previews": [], @@ -8072,6 +8194,7 @@ "url": "/marketplace_listing/plans/{plan_id}/accounts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan", "previews": [], @@ -8171,6 +8294,7 @@ "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed", "previews": [], @@ -8268,6 +8392,7 @@ "url": "/user/installations/{installation_id}/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token", "previews": [], @@ -8337,6 +8462,7 @@ "url": "/app/installations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app", "previews": [], @@ -8416,6 +8542,7 @@ "url": "/user/installations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", "previews": [], @@ -8477,6 +8604,7 @@ "url": "/marketplace_listing/plans", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans", "previews": [], @@ -8536,6 +8664,7 @@ "url": "/marketplace_listing/stubbed/plans", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all plans that are part of your GitHub Marketplace listing.\n\nGitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-plans-stubbed", "previews": [], @@ -8594,6 +8723,7 @@ "url": "/installation/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation", "previews": [], @@ -8654,6 +8784,7 @@ "url": "/user/marketplace_purchases", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user", "previews": [], @@ -8714,6 +8845,7 @@ "url": "/user/marketplace_purchases/stubbed", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the active subscriptions for the authenticated user. You must use a [user-to-server OAuth access token](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint. . OAuth Apps must authenticate using an [OAuth token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed", "previews": [], @@ -8773,6 +8905,7 @@ "url": "/app/hook/deliveries", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook", "previews": [], @@ -8829,6 +8962,7 @@ "url": "/app/hook/deliveries/{delivery_id}/attempts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook", "previews": [], @@ -8864,6 +8998,7 @@ "url": "/user/installations/{installation_id}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation", "previews": [], @@ -8912,6 +9047,7 @@ "url": "/applications/{client_id}/token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", "documentationUrl": "https://docs.github.com/rest/reference/apps#reset-a-token", "previews": [], @@ -8966,6 +9102,7 @@ "url": "/installation/token", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token", "previews": [], @@ -8982,6 +9119,7 @@ "url": "/applications/{client_id}/token/scoped", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-scoped-access-token", "previews": [], @@ -9511,6 +9649,7 @@ "url": "/app/installations/{installation_id}/suspended", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#suspend-an-app-installation", "previews": [], @@ -9544,6 +9683,7 @@ "url": "/app/installations/{installation_id}/suspended", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation", "previews": [], @@ -9577,6 +9717,7 @@ "url": "/app/hook/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app", "previews": [], @@ -9656,6 +9797,7 @@ "url": "/orgs/{org}/settings/billing/actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `repo` or `admin:org` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization", "previews": [], @@ -9696,6 +9838,7 @@ "url": "/users/{username}/settings/billing/actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the summary of the free and paid GitHub Actions minutes used.\n\nPaid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAccess tokens must have the `user` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user", "previews": [], @@ -9736,6 +9879,7 @@ "url": "/orgs/{org}/settings/billing/packages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization", "previews": [], @@ -9776,6 +9920,7 @@ "url": "/users/{username}/settings/billing/packages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the free and paid storage used for GitHub Packages in gigabytes.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user", "previews": [], @@ -9816,6 +9961,7 @@ "url": "/orgs/{org}/settings/billing/shared-storage", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `repo` or `admin:org` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization", "previews": [], @@ -9856,6 +10002,7 @@ "url": "/users/{username}/settings/billing/shared-storage", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the estimated paid and estimated total storage used for GitHub Actions and Github Packages.\n\nPaid minutes only apply to packages stored for private repositories. For more information, see \"[Managing billing for GitHub Packages](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages).\"\n\nAccess tokens must have the `user` scope.", "documentationUrl": "https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user", "previews": [], @@ -9896,6 +10043,7 @@ "url": "/repos/{owner}/{repo}/check-runs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-run", "previews": [], @@ -9975,6 +10123,7 @@ "url": "/repos/{owner}/{repo}/check-suites", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", "documentationUrl": "https://docs.github.com/rest/reference/checks#create-a-check-suite", "previews": [], @@ -10050,6 +10199,7 @@ "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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\nGets a single check run 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.", "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-run", "previews": [], @@ -10116,6 +10266,7 @@ "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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\nGets a single 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 suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", "documentationUrl": "https://docs.github.com/rest/reference/checks#get-a-check-suite", "previews": [], @@ -10182,6 +10333,7 @@ "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-run-annotations", "previews": [], @@ -10274,6 +10426,7 @@ "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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.", "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference", "previews": [], @@ -10418,6 +10571,7 @@ "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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.", "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite", "previews": [], @@ -10549,6 +10703,7 @@ "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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.", "documentationUrl": "https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference", "previews": [], @@ -10667,6 +10822,7 @@ "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", "documentationUrl": "https://docs.github.com/rest/reference/checks#rerequest-a-check-suite", "previews": [], @@ -10723,6 +10879,7 @@ "url": "/repos/{owner}/{repo}/check-suites/preferences", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", "documentationUrl": "https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites", "previews": [], @@ -10815,6 +10972,7 @@ "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "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.", "documentationUrl": "https://docs.github.com/rest/reference/checks#update-a-check-run", "previews": [], @@ -11267,6 +11425,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository", "previews": [], @@ -11355,6 +11514,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert", "previews": [], @@ -11441,6 +11601,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", "previews": [], @@ -11515,6 +11676,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository", "previews": [], @@ -11592,6 +11754,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], @@ -11682,7 +11845,7 @@ "description": "Response", "examples": [ { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" + "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" } ] }, @@ -11704,6 +11867,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", "previews": [], @@ -11842,6 +12006,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], @@ -11932,7 +12097,7 @@ "description": "Response", "examples": [ { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" + "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" } ] }, @@ -11959,6 +12124,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/analyses", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", "previews": [], @@ -12097,6 +12263,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert", "previews": [], @@ -12196,6 +12363,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/sarifs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file", "previews": [], @@ -12344,6 +12512,7 @@ "url": "/codes_of_conduct", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct", "previews": [], @@ -12371,6 +12540,7 @@ "url": "/codes_of_conduct/{key}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct", "previews": [], @@ -12411,8 +12581,9 @@ "id": "getForRepo", "method": "GET", "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "isDeprecated": false, - "deprecationDate": null, + "isDeprecated": true, + "deprecationDate": "2021-09-29", + "removalDate": "2021-09-29", "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", "previews": [{ "name": "scarlet-witch" }], @@ -12466,6 +12637,7 @@ "url": "/emojis", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all the emojis available to use on GitHub.", "documentationUrl": "https://docs.github.com/rest/reference/emojis#get-emojis", "previews": [], @@ -12485,6 +12657,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise", "previews": [], @@ -12528,6 +12701,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise", "previews": [], @@ -12571,6 +12745,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise", "previews": [], @@ -12611,6 +12786,7 @@ "url": "/enterprises/{enterprise}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise", "previews": [], @@ -12651,6 +12827,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/organizations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", "previews": [], @@ -12717,6 +12894,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise", "previews": [], @@ -12786,6 +12964,7 @@ "url": "/enterprises/{enterprise}/actions/permissions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise", "previews": [], @@ -12842,6 +13021,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/organizations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", "previews": [], @@ -12885,6 +13065,7 @@ "url": "/gists/{gist_id}/star", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred", "previews": [], @@ -12928,6 +13109,7 @@ "url": "/gists", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", "documentationUrl": "https://docs.github.com/rest/reference/gists#create-a-gist", "previews": [], @@ -13024,6 +13206,7 @@ "url": "/gists/{gist_id}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#create-a-gist-comment", "previews": [], @@ -13080,6 +13263,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#delete-a-gist", "previews": [], @@ -13115,6 +13299,7 @@ "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#delete-a-gist-comment", "previews": [], @@ -13163,6 +13348,7 @@ "url": "/gists/{gist_id}/forks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note**: This was previously `/gists/:gist_id/fork`.", "documentationUrl": "https://docs.github.com/rest/reference/gists#fork-a-gist", "previews": [], @@ -13207,6 +13393,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist", "previews": [], @@ -13250,6 +13437,7 @@ "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist-comment", "previews": [], @@ -13306,6 +13494,7 @@ "url": "/gists/{gist_id}/{sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist-revision", "previews": [], @@ -13362,6 +13551,7 @@ "url": "/gists", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user", "previews": [], @@ -13430,6 +13620,7 @@ "url": "/gists/{gist_id}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-comments", "previews": [], @@ -13499,6 +13690,7 @@ "url": "/gists/{gist_id}/commits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-commits", "previews": [], @@ -13568,6 +13760,7 @@ "url": "/users/{username}/gists", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists public gists for the specified user:", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gists-for-a-user", "previews": [], @@ -13648,6 +13841,7 @@ "url": "/gists/{gist_id}/forks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-forks", "previews": [], @@ -13717,6 +13911,7 @@ "url": "/gists/public", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-public-gists", "previews": [], @@ -13786,6 +13981,7 @@ "url": "/gists/starred", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the authenticated user's starred gists:", "documentationUrl": "https://docs.github.com/rest/reference/gists#list-starred-gists", "previews": [], @@ -13859,6 +14055,7 @@ "url": "/gists/{gist_id}/star", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/gists#star-a-gist", "previews": [], @@ -13894,6 +14091,7 @@ "url": "/gists/{gist_id}/star", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#unstar-a-gist", "previews": [], @@ -13929,6 +14127,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "documentationUrl": "https://docs.github.com/rest/reference/gists/#update-a-gist", "previews": [], @@ -14036,6 +14235,7 @@ "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/gists#update-a-gist-comment", "previews": [], @@ -14103,6 +14303,7 @@ "url": "/repos/{owner}/{repo}/git/blobs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-blob", "previews": [], @@ -14186,6 +14387,7 @@ "url": "/repos/{owner}/{repo}/git/commits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-commit", "previews": [], @@ -14397,6 +14599,7 @@ "url": "/repos/{owner}/{repo}/git/refs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-reference", "previews": [], @@ -14490,6 +14693,7 @@ "url": "/repos/{owner}/{repo}/git/tags", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-tag-object", "previews": [], @@ -14648,6 +14852,7 @@ "url": "/repos/{owner}/{repo}/git/trees", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"", "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-tree", "previews": [], @@ -14795,6 +15000,7 @@ "url": "/repos/{owner}/{repo}/git/refs/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/git#delete-a-reference", "previews": [], @@ -14854,6 +15060,7 @@ "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-blob", "previews": [], @@ -14923,6 +15130,7 @@ "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-commit", "previews": [], @@ -14990,6 +15198,7 @@ "url": "/repos/{owner}/{repo}/git/ref/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-reference", "previews": [], @@ -15057,6 +15266,7 @@ "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-tag", "previews": [], @@ -15124,6 +15334,7 @@ "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.", "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-tree", "previews": [], @@ -15208,6 +15419,7 @@ "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", "documentationUrl": "https://docs.github.com/rest/reference/git#list-matching-references", "previews": [], @@ -15300,6 +15512,7 @@ "url": "/repos/{owner}/{repo}/git/refs/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/git#update-a-reference", "previews": [], @@ -15393,6 +15606,7 @@ "url": "/gitignore/templates", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user).", "documentationUrl": "https://docs.github.com/rest/reference/gitignore#get-all-gitignore-templates", "previews": [], @@ -15420,6 +15634,7 @@ "url": "/gitignore/templates/{name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents.", "documentationUrl": "https://docs.github.com/rest/reference/gitignore#get-a-gitignore-template", "previews": [], @@ -15461,6 +15676,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories", "previews": [], @@ -15492,6 +15708,7 @@ "url": "/orgs/{org}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization", "previews": [], @@ -15532,6 +15749,7 @@ "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository", "previews": [], @@ -15585,6 +15803,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows which type of GitHub user can interact with your public repositories and when the restriction expires.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories", "previews": [], @@ -15627,6 +15846,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes any interaction restrictions from your public repositories.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories", "previews": [], @@ -15643,6 +15863,7 @@ "url": "/orgs/{org}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization", "previews": [], @@ -15673,6 +15894,7 @@ "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository", "previews": [], @@ -15719,6 +15941,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes any interaction restrictions from your public repositories.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories", "previews": [], @@ -15746,6 +15969,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories", "previews": [], @@ -15806,6 +16030,7 @@ "url": "/orgs/{org}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization", "previews": [], @@ -15879,6 +16104,7 @@ "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository", "previews": [], @@ -15965,6 +16191,7 @@ "url": "/user/interaction-limits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.", "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories", "previews": [], @@ -16036,6 +16263,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", "documentationUrl": "https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue", "previews": [], @@ -16100,7 +16328,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}" + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" } ] } @@ -16115,6 +16343,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#add-labels-to-an-issue", "previews": [], @@ -16209,6 +16438,7 @@ "url": "/repos/{owner}/{repo}/assignees/{assignee}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", "documentationUrl": "https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned", "previews": [], @@ -16276,6 +16506,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-an-issue", "previews": [], @@ -16412,6 +16643,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-an-issue-comment", "previews": [], @@ -16495,6 +16727,7 @@ "url": "/repos/{owner}/{repo}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-a-label", "previews": [], @@ -16589,6 +16822,7 @@ "url": "/repos/{owner}/{repo}/milestones", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#create-a-milestone", "previews": [], @@ -16696,6 +16930,7 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-an-issue-comment", "previews": [], @@ -16752,6 +16987,7 @@ "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-a-label", "previews": [], @@ -16808,6 +17044,7 @@ "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-a-milestone", "previews": [], @@ -16867,6 +17104,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue", "previews": [], @@ -16937,6 +17175,7 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue-comment", "previews": [], @@ -17004,6 +17243,7 @@ "url": "/repos/{owner}/{repo}/issues/events/{event_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue-event", "previews": [], @@ -17073,6 +17313,7 @@ "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-a-label", "previews": [], @@ -17140,6 +17381,7 @@ "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#get-a-milestone", "previews": [], @@ -17207,6 +17449,7 @@ "url": "/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], @@ -17400,6 +17643,7 @@ "url": "/repos/{owner}/{repo}/assignees", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-assignees", "previews": [], @@ -17480,6 +17724,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Issue Comments are ordered by ascending ID.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-comments", "previews": [], @@ -17587,6 +17832,7 @@ "url": "/repos/{owner}/{repo}/issues/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "By default, Issue Comments are ordered by ascending ID.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository", "previews": [], @@ -17707,6 +17953,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-events", "previews": [], @@ -17800,6 +18047,7 @@ "url": "/repos/{owner}/{repo}/issues/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository", "previews": [], @@ -17880,6 +18128,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue", "previews": [], @@ -17966,6 +18215,7 @@ "url": "/user/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], @@ -18106,6 +18356,7 @@ "url": "/orgs/{org}/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], @@ -18258,6 +18509,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-repository-issues", "previews": [], @@ -18439,7 +18691,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}]" + "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}]" } ] }, @@ -18457,6 +18709,7 @@ "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone", "previews": [], @@ -18549,6 +18802,7 @@ "url": "/repos/{owner}/{repo}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-a-repository", "previews": [], @@ -18629,6 +18883,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-an-issue", "previews": [], @@ -18722,6 +18977,7 @@ "url": "/repos/{owner}/{repo}/milestones", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#list-milestones", "previews": [], @@ -18841,6 +19097,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/issues#lock-an-issue", "previews": [], @@ -18916,6 +19173,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue", "previews": [], @@ -18975,6 +19233,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes one or more assignees from an issue.", "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue", "previews": [], @@ -19039,7 +19298,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}" + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" } ] } @@ -19054,6 +19313,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue", "previews": [], @@ -19135,6 +19395,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes any previous labels and sets the new labels for an issue.", "documentationUrl": "https://docs.github.com/rest/reference/issues#set-labels-for-an-issue", "previews": [], @@ -19229,6 +19490,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access can unlock an issue's conversation.", "documentationUrl": "https://docs.github.com/rest/reference/issues#unlock-an-issue", "previews": [], @@ -19289,6 +19551,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Issue owners and users with push access can edit an issue.", "documentationUrl": "https://docs.github.com/rest/reference/issues/#update-an-issue", "previews": [], @@ -19452,6 +19715,7 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#update-an-issue-comment", "previews": [], @@ -19532,6 +19796,7 @@ "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#update-a-label", "previews": [], @@ -19637,6 +19902,7 @@ "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/issues#update-a-milestone", "previews": [], @@ -19755,6 +20021,7 @@ "url": "/licenses/{license}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/licenses#get-a-license", "previews": [], @@ -19798,6 +20065,7 @@ "url": "/licenses", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses", "previews": [], @@ -19865,6 +20133,7 @@ "url": "/repos/{owner}/{repo}/license", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [Get repository content](https://docs.github.com/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", "documentationUrl": "https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository", "previews": [], @@ -19918,6 +20187,7 @@ "url": "/markdown", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/markdown#render-a-markdown-document", "previews": [], @@ -19977,6 +20247,7 @@ "url": "/markdown/raw", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", "documentationUrl": "https://docs.github.com/rest/reference/markdown#render-a-markdown-document-in-raw-mode", "previews": [], @@ -20016,6 +20287,7 @@ "url": "/meta", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", "documentationUrl": "https://docs.github.com/rest/reference/meta#get-github-meta-information", "previews": [], @@ -20043,6 +20315,7 @@ "url": "/octocat", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the octocat as ASCII art", "documentationUrl": "https://docs.github.com/rest/reference/meta#get-octocat", "previews": [], @@ -20073,6 +20346,7 @@ "url": "/zen", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get a random sentence from the Zen of GitHub", "documentationUrl": "", "previews": [], @@ -20089,6 +20363,7 @@ "url": "/", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get Hypermedia links to resources accessible in GitHub's REST API", "documentationUrl": "https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint", "previews": [], @@ -20105,6 +20380,7 @@ "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Stop an import for a repository.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#cancel-an-import", "previews": [], @@ -20148,6 +20424,7 @@ "url": "/user/migrations/{migration_id}/archive", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/reference/migrations#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/reference/migrations#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#delete-a-user-migration-archive", "previews": [], @@ -20188,6 +20465,7 @@ "url": "/orgs/{org}/migrations/{migration_id}/archive", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#delete-an-organization-migration-archive", "previews": [], @@ -20234,6 +20512,7 @@ "url": "/orgs/{org}/migrations/{migration_id}/archive", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Fetches the URL to a migration archive.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#download-an-organization-migration-archive", "previews": [], @@ -20280,6 +20559,7 @@ "url": "/user/migrations/{migration_id}/archive", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects:\n\n* attachments\n* bases\n* commit\\_comments\n* issue\\_comments\n* issue\\_events\n* issues\n* milestones\n* organizations\n* projects\n* protected\\_branches\n* pull\\_request\\_reviews\n* pull\\_requests\n* releases\n* repositories\n* review\\_comments\n* schema\n* users\n\nThe archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive", "previews": [], @@ -20319,6 +20599,7 @@ "url": "/repos/{owner}/{repo}/import/authors", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/reference/migrations#map-a-commit-author) endpoint allow you to provide correct Git author information.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#get-commit-authors", "previews": [], @@ -20386,6 +20667,7 @@ "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#get-an-import-status", "previews": [], @@ -20440,6 +20722,7 @@ "url": "/repos/{owner}/{repo}/import/large_files", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List files larger than 100MB found during the import", "documentationUrl": "https://docs.github.com/rest/reference/migrations#get-large-files", "previews": [], @@ -20493,6 +20776,7 @@ "url": "/user/migrations/{migration_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values:\n\n* `pending` - the migration hasn't started yet.\n* `exporting` - the migration is in progress.\n* `exported` - the migration finished successfully.\n* `failed` - the migration failed.\n\nOnce the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/reference/migrations#download-a-user-migration-archive).", "documentationUrl": "https://docs.github.com/rest/reference/migrations#get-a-user-migration-status", "previews": [], @@ -20554,6 +20838,7 @@ "url": "/orgs/{org}/migrations/{migration_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#get-an-organization-migration-status", "previews": [], @@ -20621,6 +20906,7 @@ "url": "/user/migrations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all migrations a user has started.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#list-user-migrations", "previews": [], @@ -20681,6 +20967,7 @@ "url": "/orgs/{org}/migrations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the most recent migrations.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#list-organization-migrations", "previews": [], @@ -20760,6 +21047,7 @@ "url": "/orgs/{org}/migrations/{migration_id}/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all the repositories for this organization migration.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#list-repositories-in-an-organization-migration", "previews": [], @@ -20840,6 +21128,7 @@ "url": "/user/migrations/{migration_id}/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all the repositories for this user migration.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration", "previews": [], @@ -20907,6 +21196,7 @@ "url": "/repos/{owner}/{repo}/import/authors/{author_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#map-a-commit-author", "previews": [], @@ -21001,6 +21291,7 @@ "url": "/repos/{owner}/{repo}/import/lfs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", "documentationUrl": "https://docs.github.com/rest/reference/migrations#update-git-lfs-preference", "previews": [], @@ -21068,6 +21359,7 @@ "url": "/user/migrations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Initiates the generation of a user migration archive.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#start-a-user-migration", "previews": [], @@ -21181,6 +21473,7 @@ "url": "/orgs/{org}/migrations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Initiates the generation of a migration archive.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#start-an-organization-migration", "previews": [], @@ -21301,6 +21594,7 @@ "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Start a source import to a GitHub repository using GitHub Importer.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#start-an-import", "previews": [], @@ -21421,6 +21715,7 @@ "url": "/user/migrations/{migration_id}/repos/{repo_name}/lock", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/reference/migrations#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/reference/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#unlock-a-user-repository", "previews": [], @@ -21474,6 +21769,7 @@ "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/reference/repos#delete-a-repository) when the migration is complete and you no longer need the source data.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#unlock-an-organization-repository", "previews": [], @@ -21533,6 +21829,7 @@ "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.", "documentationUrl": "https://docs.github.com/rest/reference/migrations#update-an-import", "previews": [], @@ -21644,6 +21941,7 @@ "url": "/authorizations", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub 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/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/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 from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/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://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#create-a-new-authorization", "previews": [], @@ -21758,6 +22056,7 @@ "url": "/authorizations/{authorization_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#delete-an-authorization", "previews": [], @@ -21797,6 +22096,7 @@ "url": "/applications/grants/{grant_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#delete-a-grant", "previews": [], @@ -21836,6 +22136,7 @@ "url": "/authorizations/{authorization_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-authorization", "previews": [], @@ -21883,6 +22184,7 @@ "url": "/applications/grants/{grant_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#get-a-single-grant", "previews": [], @@ -21930,6 +22232,7 @@ "url": "/authorizations/clients/{client_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app", "previews": [], @@ -22052,6 +22355,7 @@ "url": "/authorizations/clients/{client_id}/{fingerprint}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf 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/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint", "previews": [], @@ -22167,6 +22471,7 @@ "url": "/authorizations", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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/).", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations", "previews": [], @@ -22241,6 +22546,7 @@ "url": "/applications/grants", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/rest/reference/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#list-your-grants", "previews": [], @@ -22315,6 +22621,7 @@ "url": "/authorizations/{authorization_id}", "isDeprecated": true, "deprecationDate": "2020-02-14", + "removalDate": "2020-11-13", "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://docs.github.com/rest/reference/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/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/rest/reference/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\nIf 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/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", "documentationUrl": "https://docs.github.com/rest/reference/oauth-authorizations#update-an-existing-authorization", "previews": [], @@ -22434,6 +22741,7 @@ "url": "/orgs/{org}/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization", "previews": [], @@ -22480,6 +22788,7 @@ "url": "/orgs/{org}/invitations/{invitation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).", "documentationUrl": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation", "previews": [], @@ -22527,6 +22836,7 @@ "url": "/orgs/{org}/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization", "previews": [], @@ -22581,6 +22891,7 @@ "url": "/orgs/{org}/members/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Check if a user is, publicly or privately, a member of the organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user", "previews": [], @@ -22640,6 +22951,7 @@ "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user", "previews": [], @@ -22694,6 +23006,7 @@ "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", "documentationUrl": "https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", "previews": [], @@ -22750,6 +23063,7 @@ "url": "/orgs/{org}/invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#create-an-organization-invitation", "previews": [], @@ -22844,6 +23158,7 @@ "url": "/orgs/{org}/hooks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Here's how you can create a hook that posts payloads in JSON format:", "documentationUrl": "https://docs.github.com/rest/reference/orgs#create-an-organization-webhook", "previews": [], @@ -23016,6 +23331,7 @@ "url": "/orgs/{org}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook", "previews": [], @@ -23062,6 +23378,7 @@ "url": "/orgs/{org}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub plan information' below.\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-an-organization", "previews": [], @@ -23103,6 +23420,7 @@ "url": "/user/memberships/orgs/{org}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user", "previews": [], @@ -23145,6 +23463,7 @@ "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user", "previews": [], @@ -23200,6 +23519,7 @@ "url": "/orgs/{org}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-an-organization-webhook", "previews": [], @@ -23254,6 +23574,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-a-webhook-configuration-for-an-organization", "previews": [], @@ -23307,6 +23628,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a delivery for a webhook configured in an organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook", "previews": [], @@ -23376,6 +23698,7 @@ "url": "/organizations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organizations", "previews": [], @@ -23430,6 +23753,7 @@ "url": "/orgs/{org}/installations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization", "previews": [], @@ -23496,6 +23820,7 @@ "url": "/orgs/{org}/blocks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the users blocked by an organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization", "previews": [], @@ -23537,6 +23862,7 @@ "url": "/orgs/{org}/failed_invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations", "previews": [], @@ -23604,6 +23930,7 @@ "url": "/user/orgs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user", "previews": [], @@ -23664,6 +23991,7 @@ "url": "/users/{username}/orgs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user", "previews": [], @@ -23730,6 +24058,7 @@ "url": "/orgs/{org}/invitations/{invitation_id}/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams", "previews": [], @@ -23810,6 +24139,7 @@ "url": "/orgs/{org}/members", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-members", "previews": [], @@ -23908,6 +24238,7 @@ "url": "/user/memberships/orgs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user", "previews": [], @@ -23982,6 +24313,7 @@ "url": "/orgs/{org}/outside_collaborators", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all users who are outside collaborators of an organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization", "previews": [], @@ -24061,6 +24393,7 @@ "url": "/orgs/{org}/invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations", "previews": [], @@ -24128,6 +24461,7 @@ "url": "/orgs/{org}/public_members", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Members of an organization can choose to have their membership publicized or not.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-public-organization-members", "previews": [], @@ -24194,6 +24528,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/deliveries", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook", "previews": [], @@ -24276,6 +24611,7 @@ "url": "/orgs/{org}/hooks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-webhooks", "previews": [], @@ -24343,6 +24679,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/pings", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook", "previews": [], @@ -24389,6 +24726,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Redeliver a delivery for a webhook configured in an organization.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook", "previews": [], @@ -24450,6 +24788,7 @@ "url": "/orgs/{org}/members/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-an-organization-member", "previews": [], @@ -24496,6 +24835,7 @@ "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user", "previews": [], @@ -24543,6 +24883,7 @@ "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removing a user from this list will remove them from all the organization's repositories.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization", "previews": [], @@ -24597,6 +24938,7 @@ "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user", "previews": [], @@ -24640,6 +24982,7 @@ "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user", "previews": [], @@ -24708,6 +25051,7 @@ "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user", "previews": [], @@ -24754,6 +25098,7 @@ "url": "/orgs/{org}/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization", "previews": [], @@ -24797,6 +25142,7 @@ "url": "/orgs/{org}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", "documentationUrl": "https://docs.github.com/rest/reference/orgs/#update-an-organization", "previews": [], @@ -25091,6 +25437,7 @@ "url": "/user/memberships/orgs/{org}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user", "previews": [], @@ -25147,6 +25494,7 @@ "url": "/orgs/{org}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-an-organization-webhook", "previews": [], @@ -25306,6 +25654,7 @@ "url": "/orgs/{org}/hooks/{hook_id}/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-a-webhook-configuration-for-an-organization", "previews": [], @@ -25411,6 +25760,7 @@ "url": "/user/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user", "previews": [], @@ -25463,6 +25813,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization", "previews": [], @@ -25528,6 +25879,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user", "previews": [], @@ -25593,6 +25945,7 @@ "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user", "previews": [], @@ -25658,6 +26011,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization", "previews": [], @@ -25736,6 +26090,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.", "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user", "previews": [], @@ -25814,6 +26169,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization", "previews": [], @@ -25937,6 +26293,7 @@ "url": "/user/packages/{package_type}/{package_name}/versions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], @@ -26047,6 +26404,7 @@ "url": "/user/packages/{package_type}/{package_name}/versions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], @@ -26146,6 +26504,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization", "previews": [], @@ -26258,6 +26617,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}/versions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns all package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user", "previews": [], @@ -26331,6 +26691,7 @@ "url": "/user/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user", "previews": [], @@ -26384,6 +26745,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package in an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization", "previews": [], @@ -26450,6 +26812,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package metadata for a public package owned by a user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-a-user", "previews": [], @@ -26516,6 +26879,7 @@ "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package version for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user", "previews": [], @@ -26582,6 +26946,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization", "previews": [], @@ -26661,6 +27026,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a specific package version for a public package owned by a specified user.\n\nAt this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user", "previews": [], @@ -26740,6 +27106,7 @@ "url": "/user/packages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", "previews": [], @@ -26793,6 +27160,7 @@ "url": "/orgs/{org}/packages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", "previews": [], @@ -26865,6 +27233,7 @@ "url": "/users/{username}/packages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", "previews": [], @@ -26937,6 +27306,7 @@ "url": "/user/packages/{package_type}/{package_name}/restore{?token}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user", "previews": [], @@ -27002,6 +27372,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/restore{?token}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization", "previews": [], @@ -27080,6 +27451,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}/restore{?token}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", "previews": [], @@ -27158,6 +27530,7 @@ "url": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user", "previews": [], @@ -27223,6 +27596,7 @@ "url": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization", "previews": [], @@ -27301,6 +27675,7 @@ "url": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.", "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user", "previews": [], @@ -27379,6 +27754,7 @@ "url": "/projects/{project_id}/collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", "documentationUrl": "https://docs.github.com/rest/reference/projects#add-project-collaborator", "previews": [], @@ -27446,6 +27822,7 @@ "url": "/projects/columns/{column_id}/cards", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-project-card", "previews": [], @@ -27534,6 +27911,7 @@ "url": "/projects/{project_id}/columns", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-project-column", "previews": [], @@ -27595,6 +27973,7 @@ "url": "/user/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-user-project", "previews": [], @@ -27661,6 +28040,7 @@ "url": "/orgs/{org}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#create-an-organization-project", "previews": [], @@ -27736,6 +28116,7 @@ "url": "/repos/{owner}/{repo}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-repository-project", "previews": [], @@ -27824,6 +28205,7 @@ "url": "/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", "documentationUrl": "https://docs.github.com/rest/reference/projects#delete-a-project", "previews": [], @@ -27865,6 +28247,7 @@ "url": "/projects/columns/cards/{card_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#delete-a-project-card", "previews": [], @@ -27905,6 +28288,7 @@ "url": "/projects/columns/{column_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#delete-a-project-column", "previews": [], @@ -27944,6 +28328,7 @@ "url": "/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#get-a-project", "previews": [], @@ -27991,6 +28376,7 @@ "url": "/projects/columns/cards/{card_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#get-a-project-card", "previews": [], @@ -28039,6 +28425,7 @@ "url": "/projects/columns/{column_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#get-a-project-column", "previews": [], @@ -28087,6 +28474,7 @@ "url": "/projects/{project_id}/collaborators/{username}/permission", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", "documentationUrl": "https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user", "previews": [], @@ -28149,6 +28537,7 @@ "url": "/projects/columns/{column_id}/cards", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-project-cards", "previews": [], @@ -28235,6 +28624,7 @@ "url": "/projects/{project_id}/collaborators", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-project-collaborators", "previews": [], @@ -28323,6 +28713,7 @@ "url": "/projects/{project_id}/columns", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-project-columns", "previews": [], @@ -28396,6 +28787,7 @@ "url": "/orgs/{org}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-organization-projects", "previews": [], @@ -28476,6 +28868,7 @@ "url": "/repos/{owner}/{repo}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-repository-projects", "previews": [], @@ -28577,6 +28970,7 @@ "url": "/users/{username}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#list-user-projects", "previews": [], @@ -28657,6 +29051,7 @@ "url": "/projects/columns/cards/{card_id}/moves", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#move-a-project-card", "previews": [], @@ -28724,6 +29119,7 @@ "url": "/projects/columns/{column_id}/moves", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#move-a-project-column", "previews": [], @@ -28777,6 +29173,7 @@ "url": "/projects/{project_id}/collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", "documentationUrl": "https://docs.github.com/rest/reference/projects#remove-project-collaborator", "previews": [], @@ -28831,6 +29228,7 @@ "url": "/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "documentationUrl": "https://docs.github.com/rest/reference/projects#update-a-project", "previews": [], @@ -28950,6 +29348,7 @@ "url": "/projects/columns/cards/{card_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#update-a-project-card", "previews": [], @@ -29025,6 +29424,7 @@ "url": "/projects/columns/{column_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/projects#update-a-project-column", "previews": [], @@ -29085,6 +29485,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged", "previews": [], @@ -29152,6 +29553,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-pull-request", "previews": [], @@ -29298,6 +29700,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment", "previews": [], @@ -29391,6 +29794,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request", "previews": [], @@ -29602,6 +30006,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request", "previews": [], @@ -29787,6 +30192,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request", "previews": [], @@ -29868,6 +30274,7 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a review comment.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request", "previews": [], @@ -29927,6 +30334,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request", "previews": [], @@ -30034,6 +30442,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/reference/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-a-pull-request", "previews": [], @@ -30103,6 +30512,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request", "previews": [], @@ -30183,6 +30593,7 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Provides details for a review comment.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request", "previews": [], @@ -30250,6 +30661,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-pull-requests", "previews": [], @@ -30396,6 +30808,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List comments for a specific pull request review.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review", "previews": [], @@ -30502,6 +30915,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/reference/repos#list-commits) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request", "previews": [], @@ -30594,6 +31008,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-pull-requests-files", "previews": [], @@ -30688,6 +31103,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request", "previews": [], @@ -30780,6 +31196,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request", "previews": [], @@ -30911,6 +31328,7 @@ "url": "/repos/{owner}/{repo}/pulls/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository", "previews": [], @@ -31029,6 +31447,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The list of reviews returns in chronological order.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request", "previews": [], @@ -31121,6 +31540,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#merge-a-pull-request", "previews": [], @@ -31258,6 +31678,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request", "previews": [], @@ -31343,6 +31764,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request", "previews": [], @@ -31441,6 +31863,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request", "previews": [], @@ -31549,6 +31972,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", "documentationUrl": "https://docs.github.com/rest/reference/pulls/#update-a-pull-request", "previews": [], @@ -31682,6 +32106,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#update-a-pull-request-branch", "previews": [], @@ -31763,6 +32188,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Update the review summary comment with new text.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request", "previews": [], @@ -31856,6 +32282,7 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables you to edit a review comment.", "documentationUrl": "https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request", "previews": [], @@ -31935,6 +32362,7 @@ "url": "/rate_limit", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "documentationUrl": "https://docs.github.com/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user", "previews": [], @@ -31963,9 +32391,10 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32066,9 +32495,10 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to an [issue](https://docs.github.com/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32152,11 +32582,6 @@ } ] }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -32169,9 +32594,10 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32255,11 +32681,6 @@ } ] }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -32272,9 +32693,10 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32358,11 +32780,6 @@ } ] }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -32375,9 +32792,10 @@ "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32452,11 +32870,6 @@ } ] }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, { "code": 422, "description": "Validation failed", "examples": null } ], "renamed": null @@ -32469,9 +32882,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32579,9 +32993,10 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": true, "deprecationDate": "2020-02-26", + "removalDate": "2021-02-21", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Create reaction for a team discussion comment](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment.", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32667,9 +33082,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32764,9 +33180,10 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", "isDeprecated": true, "deprecationDate": "2020-02-26", + "removalDate": "2021-02-21", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion.", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32839,9 +33256,10 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-a-commit-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32908,9 +33326,10 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/rest/reference/issues/).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -32977,9 +33396,10 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33046,9 +33466,10 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33115,9 +33536,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33184,9 +33606,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33266,9 +33689,10 @@ "url": "/reactions/{reaction_id}", "isDeprecated": true, "deprecationDate": "2020-02-26", + "removalDate": "2021-02-21", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33294,8 +33718,7 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 410, "description": "Gone", "examples": null } ], "renamed": null }, @@ -33307,9 +33730,10 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33410,8 +33834,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -33423,9 +33846,10 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to an [issue](https://docs.github.com/rest/reference/issues).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33527,8 +33951,7 @@ ] }, { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 410, "description": "Gone", "examples": null } ], "renamed": null }, @@ -33540,9 +33963,10 @@ "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33643,8 +34067,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -33656,9 +34079,10 @@ "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments).", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33759,8 +34183,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -33772,9 +34195,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -33899,9 +34323,10 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": true, "deprecationDate": "2020-02-26", + "removalDate": "2021-02-21", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -34013,9 +34438,10 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", "documentationUrl": "https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -34127,9 +34553,10 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", "isDeprecated": true, "deprecationDate": "2020-02-26", + "removalDate": "2021-02-21", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], + "previews": [], "headers": [], "parameters": [ { @@ -34228,6 +34655,7 @@ "url": "/user/repository_invitations/{invitation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation", "previews": [], @@ -34264,6 +34692,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions", "previews": [], @@ -34344,6 +34773,7 @@ "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-a-repository-collaborator", "previews": [], @@ -34443,6 +34873,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-status-check-contexts", "previews": [], @@ -34525,6 +34956,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-team-access-restrictions", "previews": [], @@ -34605,6 +35037,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#add-user-access-restrictions", "previews": [], @@ -34685,6 +35118,7 @@ "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", "documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-a-user-is-a-repository-collaborator", "previews": [], @@ -34752,6 +35186,7 @@ "url": "/repos/{owner}/{repo}/vulnerability-alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository", "previews": [], @@ -34806,6 +35241,7 @@ "url": "/repos/{owner}/{repo}/compare/{base}...{head}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#compare-two-commits", "previews": [], @@ -34913,6 +35349,7 @@ "url": "/repos/{owner}/{repo}/compare/{basehead}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#compare-two-commits", "previews": [], @@ -35007,6 +35444,7 @@ "url": "/repos/{owner}/{repo}/autolinks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with admin access to the repository can create an autolink.", "documentationUrl": "https://docs.github.com/v3/repos#create-an-autolink", "previews": [], @@ -35087,6 +35525,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-commit-comment", "previews": [], @@ -35207,6 +35646,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection", "previews": [{ "name": "zzzax" }], @@ -35274,6 +35714,7 @@ "url": "/repos/{owner}/{repo}/statuses/{sha}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-commit-status", "previews": [], @@ -35392,6 +35833,7 @@ "url": "/repos/{owner}/{repo}/keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You can create a read-only deploy key.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deploy-key", "previews": [], @@ -35485,6 +35927,7 @@ "url": "/repos/{owner}/{repo}/deployments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deployment", "previews": [], @@ -35609,7 +36052,7 @@ }, { "name": "transient_environment", - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", "in": "BODY", "type": "boolean", "required": false, @@ -35622,7 +36065,7 @@ }, { "name": "production_environment", - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", "in": "BODY", "type": "boolean", "required": false, @@ -35670,6 +36113,7 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deployment-status", "previews": [], @@ -35716,7 +36160,7 @@ }, { "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", "in": "BODY", "type": "string", "required": true, @@ -35750,7 +36194,7 @@ }, { "name": "log_url", - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", "in": "BODY", "type": "string", "required": false, @@ -35776,7 +36220,7 @@ }, { "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type.", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", "in": "BODY", "type": "string", "required": false, @@ -35789,7 +36233,7 @@ }, { "name": "environment_url", - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "description": "Sets the URL for accessing your environment. Default: `\"\"`", "in": "BODY", "type": "string", "required": false, @@ -35802,7 +36246,7 @@ }, { "name": "auto_inactive", - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/rest/overview/api-previews#enhanced-deployments) custom media type.", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", "in": "BODY", "type": "boolean", "required": false, @@ -35836,6 +36280,7 @@ "url": "/repos/{owner}/{repo}/dispatches", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event", "previews": [], @@ -35921,6 +36366,7 @@ "url": "/user/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user", "previews": [], @@ -36193,6 +36639,7 @@ "url": "/repos/{owner}/{repo}/forks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-fork", "previews": [], @@ -36264,6 +36711,7 @@ "url": "/orgs/{org}/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-an-organization-repository", "previews": [], @@ -36540,6 +36988,7 @@ "url": "/repos/{owner}/{repo}/environments/{environment_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment", "previews": [], @@ -36702,6 +37151,7 @@ "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new file or replaces an existing file in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents", "previews": [], @@ -36936,6 +37386,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-github-pages-site", "previews": [{ "name": "switcheroo" }], @@ -37035,6 +37486,7 @@ "url": "/repos/{owner}/{repo}/releases", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-release", "previews": [], @@ -37185,6 +37637,7 @@ "url": "/repos/{template_owner}/{template_repo}/generate", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template", "previews": [{ "name": "baptiste" }], @@ -37303,6 +37756,7 @@ "url": "/repos/{owner}/{repo}/hooks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-repository-webhook", "previews": [], @@ -37489,6 +37943,7 @@ "url": "/user/repository_invitations/{invitation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation", "previews": [], @@ -37525,6 +37980,7 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-repository", "previews": [], @@ -37581,6 +38037,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-access-restrictions", "previews": [], @@ -37637,6 +38094,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-admin-branch-protection", "previews": [], @@ -37696,6 +38154,7 @@ "url": "/repos/{owner}/{repo}/environments/{environment_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You must authenticate using an access token with the repo scope to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-an-environment", "previews": [], @@ -37754,6 +38213,7 @@ "url": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", "documentationUrl": "https://docs.github.com/v3/repos#delete-autolink", "previews": [], @@ -37813,6 +38273,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-branch-protection", "previews": [], @@ -37872,6 +38333,7 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-commit-comment", "previews": [], @@ -37931,6 +38393,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection", "previews": [{ "name": "zzzax" }], @@ -37990,6 +38453,7 @@ "url": "/repos/{owner}/{repo}/keys/{key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-deploy-key", "previews": [], @@ -38046,6 +38510,7 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-deployment", "previews": [], @@ -38106,6 +38571,7 @@ "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-file", "previews": [], @@ -38293,6 +38759,7 @@ "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-repository-invitation", "previews": [], @@ -38349,6 +38816,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-github-pages-site", "previews": [{ "name": "switcheroo" }], @@ -38401,6 +38869,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection", "previews": [], @@ -38460,6 +38929,7 @@ "url": "/repos/{owner}/{repo}/releases/{release_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access to the repository can delete a release.", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-release", "previews": [], @@ -38516,6 +38986,7 @@ "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-release-asset", "previews": [], @@ -38572,6 +39043,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-repository-webhook", "previews": [], @@ -38631,6 +39103,7 @@ "url": "/repos/{owner}/{repo}/automated-security-fixes", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-automated-security-fixes", "previews": [], @@ -38674,6 +39147,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository", "previews": [], @@ -38717,6 +39191,7 @@ "url": "/repos/{owner}/{repo}/vulnerability-alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts", "previews": [], @@ -38760,6 +39235,7 @@ "url": "/repos/{owner}/{repo}/tarball/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", "previews": [], @@ -38821,6 +39297,7 @@ "url": "/repos/{owner}/{repo}/zipball/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", "previews": [], @@ -38882,6 +39359,7 @@ "url": "/repos/{owner}/{repo}/tarball/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", "previews": [], @@ -38938,6 +39416,7 @@ "url": "/repos/{owner}/{repo}/zipball/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", "previews": [], @@ -38994,6 +39473,7 @@ "url": "/repos/{owner}/{repo}/automated-security-fixes", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-automated-security-fixes", "previews": [], @@ -39037,6 +39517,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository", "previews": [], @@ -39087,6 +39568,7 @@ "url": "/repos/{owner}/{repo}/vulnerability-alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".", "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts", "previews": [], @@ -39130,7 +39612,8 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, - "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "removalDate": null, + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository", "previews": [], "headers": [], @@ -39169,9 +39652,6 @@ "examples": [ { "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" - }, - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"code_of_conduct\":{\"key\":\"other\",\"name\":\"Other\",\"html_url\":\"https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md\",\"url\":\"https://api.github.com/repos/github/docs/community/code_of_conduct\"}}" } ] }, @@ -39189,6 +39669,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-access-restrictions", "previews": [], @@ -39256,6 +39737,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection", "previews": [], @@ -39322,6 +39804,7 @@ "url": "/repos/{owner}/{repo}/environments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get all environments for a repository.\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.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-environments", "previews": [], @@ -39375,6 +39858,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-status-check-contexts", "previews": [], @@ -39438,6 +39922,7 @@ "url": "/repos/{owner}/{repo}/topics", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-repository-topics", "previews": [{ "name": "mercy" }], @@ -39517,6 +40002,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch", "previews": [], @@ -39584,6 +40070,7 @@ "url": "/repos/{owner}/{repo}/autolinks/{autolink_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", "documentationUrl": "https://docs.github.com/v3/repos#get-autolink", "previews": [], @@ -39651,6 +40138,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-branch", "previews": [], @@ -39712,6 +40200,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-branch-protection", "previews": [], @@ -39779,6 +40268,7 @@ "url": "/repos/{owner}/{repo}/traffic/clones", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-repository-clones", "previews": [], @@ -39846,6 +40336,7 @@ "url": "/repos/{owner}/{repo}/stats/code_frequency", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-weekly-commit-activity", "previews": [], @@ -39901,6 +40392,7 @@ "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-repository-permissions-for-a-user", "previews": [], @@ -39968,6 +40460,7 @@ "url": "/repos/{owner}/{repo}/commits/{ref}/status", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-combined-status-for-a-specific-reference", "previews": [], @@ -40061,6 +40554,7 @@ "url": "/repos/{owner}/{repo}/commits/{ref}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\n**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.\n\nYou can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-commit", "previews": [], @@ -40156,6 +40650,7 @@ "url": "/repos/{owner}/{repo}/stats/commit_activity", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-last-year-of-commit-activity", "previews": [], @@ -40215,6 +40710,7 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-commit-comment", "previews": [], @@ -40282,6 +40778,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection", "previews": [{ "name": "zzzax" }], @@ -40349,6 +40846,7 @@ "url": "/repos/{owner}/{repo}/community/profile", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint will return all community profile metrics, including an\noverall health score, repository description, the presence of documentation, detected\ncode of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-community-profile-metrics", "previews": [], @@ -40402,6 +40900,7 @@ "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit\n`:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. \n\nFiles and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-repository-content", "previews": [], @@ -40494,6 +40993,7 @@ "url": "/repos/{owner}/{repo}/stats/contributors", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "\nReturns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information:\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-contributor-commit-activity", "previews": [], @@ -40553,6 +41053,7 @@ "url": "/repos/{owner}/{repo}/keys/{key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deploy-key", "previews": [], @@ -40620,6 +41121,7 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deployment", "previews": [], @@ -40687,6 +41189,7 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with pull access can view a deployment status for a deployment:", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deployment-status", "previews": [], @@ -40755,8 +41258,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, @@ -40768,6 +41270,7 @@ "url": "/repos/{owner}/{repo}/environments/{environment_name}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Anyone 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.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-an-environment", "previews": [], @@ -40834,6 +41337,7 @@ "url": "/repos/{owner}/{repo}/pages/builds/latest", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-latest-pages-build", "previews": [], @@ -40887,6 +41391,7 @@ "url": "/repos/{owner}/{repo}/releases/latest", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-latest-release", "previews": [], @@ -40940,6 +41445,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-github-pages-site", "previews": [], @@ -40994,6 +41500,7 @@ "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-github-pages-build", "previews": [], @@ -41060,6 +41567,7 @@ "url": "/repos/{owner}/{repo}/pages/health", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nUsers must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-dns-health-check-for-github-pages", "previews": [], @@ -41125,6 +41633,7 @@ "url": "/repos/{owner}/{repo}/stats/participation", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-weekly-commit-count", "previews": [], @@ -41179,6 +41688,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-pull-request-review-protection", "previews": [], @@ -41245,6 +41755,7 @@ "url": "/repos/{owner}/{repo}/stats/punch_card", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-the-hourly-commit-count-for-each-day", "previews": [], @@ -41299,6 +41810,7 @@ "url": "/repos/{owner}/{repo}/readme", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository-readme", "previews": [], @@ -41367,6 +41879,7 @@ "url": "/repos/{owner}/{repo}/readme/{dir}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme", "previews": [], @@ -41448,6 +41961,7 @@ "url": "/repos/{owner}/{repo}/releases/{release_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia).", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-release", "previews": [], @@ -41515,6 +42029,7 @@ "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-release-asset", "previews": [], @@ -41584,6 +42099,7 @@ "url": "/repos/{owner}/{repo}/releases/tags/{tag}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get a published release with the specified tag.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name", "previews": [], @@ -41651,6 +42167,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-status-checks-protection", "previews": [], @@ -41718,6 +42235,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch", "previews": [], @@ -41785,6 +42303,7 @@ "url": "/repos/{owner}/{repo}/traffic/popular/paths", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the top 10 popular contents over the last 14 days.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-top-referral-paths", "previews": [], @@ -41839,6 +42358,7 @@ "url": "/repos/{owner}/{repo}/traffic/popular/referrers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the top 10 referrers over the last 14 days.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-top-referral-sources", "previews": [], @@ -41893,6 +42413,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch", "previews": [], @@ -41960,6 +42481,7 @@ "url": "/repos/{owner}/{repo}/traffic/views", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-page-views", "previews": [], @@ -42027,6 +42549,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository-webhook", "previews": [], @@ -42094,6 +42617,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use \"[Get a repository webhook](/rest/reference/orgs#get-a-repository-webhook).\"\n\nAccess tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-webhook-configuration-for-a-repository", "previews": [], @@ -42160,6 +42684,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a delivery for a webhook configured in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-delivery-for-a-repository-webhook", "previews": [], @@ -42242,6 +42767,7 @@ "url": "/repos/{owner}/{repo}/autolinks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This returns a list of autolinks configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", "documentationUrl": "https://docs.github.com/v3/repos#list-autolinks", "previews": [], @@ -42308,6 +42834,7 @@ "url": "/repos/{owner}/{repo}/branches", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-branches", "previews": [], @@ -42401,6 +42928,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-branches-for-head-commit", "previews": [], @@ -42468,6 +42996,7 @@ "url": "/repos/{owner}/{repo}/collaborators", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-collaborators", "previews": [], @@ -42561,6 +43090,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-commit-comments", "previews": [], @@ -42653,6 +43183,7 @@ "url": "/repos/{owner}/{repo}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Commit Comments use [these custom media types](https://docs.github.com/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-commit-comments-for-a-repository", "previews": [], @@ -42732,6 +43263,7 @@ "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-commit-statuses-for-a-reference", "previews": [], @@ -42825,6 +43357,7 @@ "url": "/repos/{owner}/{repo}/commits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-commits", "previews": [], @@ -42974,6 +43507,7 @@ "url": "/repos/{owner}/{repo}/contributors", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-contributors", "previews": [], @@ -43073,6 +43607,7 @@ "url": "/repos/{owner}/{repo}/keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deploy-keys", "previews": [], @@ -43152,6 +43687,7 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with pull access can view deployment statuses for a deployment:", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deployment-statuses", "previews": [], @@ -43245,6 +43781,7 @@ "url": "/repos/{owner}/{repo}/deployments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Simple filtering of deployments is available via query parameters:", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deployments", "previews": [], @@ -43376,6 +43913,7 @@ "url": "/user/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user", "previews": [], @@ -43528,6 +44066,7 @@ "url": "/orgs/{org}/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists repositories for the specified organization.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-organization-repositories", "previews": [], @@ -43641,6 +44180,7 @@ "url": "/users/{username}/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repositories-for-a-user", "previews": [], @@ -43746,6 +44286,7 @@ "url": "/repos/{owner}/{repo}/forks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-forks", "previews": [], @@ -43840,6 +44381,7 @@ "url": "/repos/{owner}/{repo}/invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-invitations", "previews": [], @@ -43919,6 +44461,7 @@ "url": "/user/repository_invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-invitations-for-the-authenticated-user", "previews": [], @@ -43980,6 +44523,7 @@ "url": "/repos/{owner}/{repo}/languages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-languages", "previews": [], @@ -44029,6 +44573,7 @@ "url": "/repos/{owner}/{repo}/pages/builds", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-github-pages-builds", "previews": [], @@ -44108,6 +44653,7 @@ "url": "/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-public-repositories", "previews": [], @@ -44150,6 +44696,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-pull-requests-associated-with-a-commit", "previews": [], @@ -44242,6 +44789,7 @@ "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-release-assets", "previews": [], @@ -44334,6 +44882,7 @@ "url": "/repos/{owner}/{repo}/releases", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-releases", "previews": [], @@ -44414,6 +44963,7 @@ "url": "/repos/{owner}/{repo}/tags", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-tags", "previews": [], @@ -44493,6 +45043,7 @@ "url": "/repos/{owner}/{repo}/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-teams", "previews": [], @@ -44572,6 +45123,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deliveries-for-a-repository-webhook", "previews": [], @@ -44667,6 +45219,7 @@ "url": "/repos/{owner}/{repo}/hooks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-webhooks", "previews": [], @@ -44747,6 +45300,7 @@ "url": "/repos/{owner}/{repo}/merges", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#merge-a-branch", "previews": [], @@ -44856,6 +45410,7 @@ "url": "/repos/{owner}/{repo}/merge-upstream", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** This endpoint is currently in beta and subject to change.\n\nSync a branch of a forked repository to keep it up-to-date with the upstream repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", "previews": [], @@ -44932,6 +45487,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", "documentationUrl": "https://docs.github.com/rest/reference/repos#ping-a-repository-webhook", "previews": [], @@ -44991,6 +45547,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Redeliver a webhook delivery for a webhook configured in a repository.", "documentationUrl": "https://docs.github.com/rest/reference/repos#redeliver-a-delivery-for-a-repository-webhook", "previews": [], @@ -45065,6 +45622,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-app-access-restrictions", "previews": [], @@ -45145,6 +45703,7 @@ "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-a-repository-collaborator", "previews": [], @@ -45201,6 +45760,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-contexts", "previews": [], @@ -45278,6 +45838,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-protection", "previews": [], @@ -45334,6 +45895,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-team-access-restrictions", "previews": [], @@ -45414,6 +45976,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-user-access-restrictions", "previews": [], @@ -45494,6 +46057,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/rename", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.\n\nTo rename a non-default branch:\n\n* Users must have push access.\n* GitHub Apps must have the `contents:write` repository permission.\n\nTo rename the default branch:\n\n* Users must have admin or owner permissions.\n* GitHub Apps must have the `administration:write` repository permission.", "documentationUrl": "https://docs.github.com/rest/reference/repos#rename-a-branch", "previews": [], @@ -45576,6 +46140,7 @@ "url": "/repos/{owner}/{repo}/topics", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#replace-all-repository-topics", "previews": [{ "name": "mercy" }], @@ -45647,6 +46212,7 @@ "url": "/repos/{owner}/{repo}/pages/builds", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", "documentationUrl": "https://docs.github.com/rest/reference/repos#request-a-github-pages-build", "previews": [], @@ -45700,6 +46266,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-admin-branch-protection", "previews": [], @@ -45766,6 +46333,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-app-access-restrictions", "previews": [], @@ -45846,6 +46414,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-status-check-contexts", "previews": [], @@ -45923,6 +46492,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-team-access-restrictions", "previews": [], @@ -46003,6 +46573,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", "documentationUrl": "https://docs.github.com/rest/reference/repos#set-user-access-restrictions", "previews": [], @@ -46083,6 +46654,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", "documentationUrl": "https://docs.github.com/rest/reference/repos#test-the-push-repository-webhook", "previews": [], @@ -46142,6 +46714,7 @@ "url": "/repos/{owner}/{repo}/transfer", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/rest/reference/repos#transfer-a-repository", "previews": [], @@ -46221,6 +46794,7 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/repos/#update-a-repository", "previews": [], @@ -46564,6 +47138,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-branch-protection", "previews": [], @@ -46872,6 +47447,7 @@ "url": "/repos/{owner}/{repo}/comments/{comment_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-commit-comment", "previews": [], @@ -46952,6 +47528,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-information-about-a-github-pages-site", "previews": [], @@ -47052,6 +47629,7 @@ "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-repository-invitation", "previews": [], @@ -47131,6 +47709,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-pull-request-review-protection", "previews": [], @@ -47276,6 +47855,7 @@ "url": "/repos/{owner}/{repo}/releases/{release_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access to the repository can edit a release.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-release", "previews": [], @@ -47438,6 +48018,7 @@ "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Users with push access to the repository can edit a release asset.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-release-asset", "previews": [], @@ -47543,6 +48124,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-potection", "previews": [], @@ -47642,6 +48224,7 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-potection", "previews": [], @@ -47736,6 +48319,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-repository-webhook", "previews": [], @@ -47947,6 +48531,7 @@ "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use \"[Update a repository webhook](/rest/reference/orgs#update-a-repository-webhook).\"\n\nAccess tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission.", "documentationUrl": "https://docs.github.com/rest/reference/repos#update-a-webhook-configuration-for-a-repository", "previews": [], @@ -48065,6 +48650,7 @@ "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/reference/repos#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: \n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.\n\nWhen an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted.\n\n**Notes:**\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.", "documentationUrl": "https://docs.github.com/rest/reference/repos#upload-a-release-asset", "previews": [], @@ -48183,6 +48769,7 @@ "url": "/search/code", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.", "documentationUrl": "https://docs.github.com/rest/reference/search#search-code", "previews": [], @@ -48279,6 +48866,7 @@ "url": "/search/commits", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`", "documentationUrl": "https://docs.github.com/rest/reference/search#search-commits", "previews": [{ "name": "cloak" }], @@ -48373,6 +48961,7 @@ "url": "/search/issues", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted\nsearch results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "documentationUrl": "https://docs.github.com/rest/reference/search#search-issues-and-pull-requests", "previews": [], @@ -48481,6 +49070,7 @@ "url": "/search/labels", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", "documentationUrl": "https://docs.github.com/rest/reference/search#search-labels", "previews": [], @@ -48590,6 +49180,7 @@ "url": "/search/repositories", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", "documentationUrl": "https://docs.github.com/rest/reference/search#search-repositories", "previews": [], @@ -48685,6 +49276,7 @@ "url": "/search/topics", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "documentationUrl": "https://docs.github.com/rest/reference/search#search-topics", "previews": [{ "name": "mercy" }], @@ -48753,6 +49345,7 @@ "url": "/search/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", "documentationUrl": "https://docs.github.com/rest/reference/search#search-users", "previews": [], @@ -48848,6 +49441,7 @@ "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert", "previews": [], @@ -48920,6 +49514,7 @@ "url": "/orgs/{org}/secret-scanning/alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all secret scanning alerts for all eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-by-organization", "previews": [], @@ -49014,6 +49609,7 @@ "url": "/repos/{owner}/{repo}/secret-scanning/alerts", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository", "previews": [], @@ -49125,6 +49721,7 @@ "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert", "previews": [], @@ -49234,6 +49831,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-team-member-legacy", "previews": [], @@ -49290,6 +49888,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user", "previews": [], @@ -49379,6 +49978,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", "previews": [], @@ -49456,6 +50056,7 @@ "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions", "previews": [], @@ -49536,6 +50137,7 @@ "url": "/teams/{team_id}/projects/{project_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-project-permissions-legacy", "previews": [], @@ -49605,6 +50207,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions", "previews": [], @@ -49687,6 +50290,7 @@ "url": "/teams/{team_id}/repos/{owner}/{repo}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", "previews": [], @@ -49760,6 +50364,7 @@ "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project", "previews": [], @@ -49831,6 +50436,7 @@ "url": "/teams/{team_id}/projects/{project_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-project-legacy", "previews": [], @@ -49889,6 +50495,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository", "previews": [], @@ -49978,6 +50585,7 @@ "url": "/teams/{team_id}/repos/{owner}/{repo}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header:", "documentationUrl": "https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", "previews": [], @@ -50054,6 +50662,7 @@ "url": "/orgs/{org}/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-team", "previews": [], @@ -50187,6 +50796,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment", "previews": [], @@ -50266,6 +50876,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy", "previews": [], @@ -50332,6 +50943,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion", "previews": [], @@ -50424,6 +51036,7 @@ "url": "/teams/{team_id}/discussions", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-legacy", "previews": [], @@ -50503,6 +51116,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#delete-a-discussion-comment", "previews": [], @@ -50572,6 +51186,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#delete-a-discussion-comment-legacy", "previews": [], @@ -50628,6 +51243,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#delete-a-discussion", "previews": [], @@ -50684,6 +51300,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/reference/teams#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#delete-a-discussion-legacy", "previews": [], @@ -50727,6 +51344,7 @@ "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#delete-a-team", "previews": [], @@ -50770,6 +51388,7 @@ "url": "/teams/{team_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/reference/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#delete-a-team-legacy", "previews": [], @@ -50804,6 +51423,7 @@ "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-a-team-by-name", "previews": [], @@ -50858,6 +51478,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-a-discussion-comment", "previews": [], @@ -50937,6 +51558,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/reference/teams#get-a-discussion-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-a-discussion-comment-legacy", "previews": [], @@ -51003,6 +51625,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-a-discussion", "previews": [], @@ -51069,6 +51692,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/reference/teams#get-a-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-a-discussion-legacy", "previews": [], @@ -51122,6 +51746,7 @@ "url": "/teams/{team_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/reference/teams#get-a-team-by-name) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#get-a-team-legacy", "previews": [], @@ -51163,6 +51788,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-team-member-legacy", "previews": [], @@ -51213,6 +51839,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user", "previews": [], @@ -51284,6 +51911,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/reference/teams#create-a-team).", "documentationUrl": "https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user-legacy", "previews": [], @@ -51338,6 +51966,7 @@ "url": "/orgs/{org}/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all teams in an organization that are visible to the authenticated user.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-teams", "previews": [], @@ -51405,6 +52034,7 @@ "url": "/orgs/{org}/teams/{team_slug}/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-child-teams", "previews": [], @@ -51484,6 +52114,7 @@ "url": "/teams/{team_id}/teams", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/reference/teams#list-child-teams) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#list-child-teams-legacy", "previews": [], @@ -51553,6 +52184,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-discussion-comments", "previews": [], @@ -51658,6 +52290,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/reference/teams#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-discussion-comments-legacy", "previews": [], @@ -51750,6 +52383,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-discussions", "previews": [], @@ -51855,6 +52489,7 @@ "url": "/teams/{team_id}/discussions", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/reference/teams#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-discussions-legacy", "previews": [], @@ -51934,6 +52569,7 @@ "url": "/user/teams", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user", "previews": [], @@ -51990,6 +52626,7 @@ "url": "/orgs/{org}/teams/{team_slug}/members", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-team-members", "previews": [], @@ -52082,6 +52719,7 @@ "url": "/teams/{team_id}/members", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/reference/teams#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-team-members-legacy", "previews": [], @@ -52162,6 +52800,7 @@ "url": "/orgs/{org}/teams/{team_slug}/invitations", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-pending-team-invitations", "previews": [], @@ -52241,6 +52880,7 @@ "url": "/teams/{team_id}/invitations", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/reference/teams#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-pending-team-invitations-legacy", "previews": [], @@ -52307,6 +52947,7 @@ "url": "/orgs/{org}/teams/{team_slug}/projects", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-team-projects", "previews": [], @@ -52386,6 +53027,7 @@ "url": "/teams/{team_id}/projects", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/reference/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#list-team-projects-legacy", "previews": [], @@ -52453,6 +53095,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#list-team-repositories", "previews": [], @@ -52532,6 +53175,7 @@ "url": "/teams/{team_id}/repos", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/reference/teams#list-team-repositories) endpoint.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#list-team-repositories-legacy", "previews": [], @@ -52599,6 +53243,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-member-legacy", "previews": [], @@ -52649,6 +53294,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user", "previews": [], @@ -52712,6 +53358,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user-legacy", "previews": [], @@ -52762,6 +53409,7 @@ "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team", "previews": [], @@ -52818,6 +53466,7 @@ "url": "/teams/{team_id}/projects/{project_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#remove-a-project-from-a-team-legacy", "previews": [], @@ -52870,6 +53519,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team", "previews": [], @@ -52939,6 +53589,7 @@ "url": "/teams/{team_id}/repos/{owner}/{repo}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team-legacy", "previews": [], @@ -52995,6 +53646,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#update-a-discussion-comment", "previews": [], @@ -53087,6 +53739,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/reference/teams#update-a-discussion-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#update-a-discussion-comment-legacy", "previews": [], @@ -53166,6 +53819,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#update-a-discussion", "previews": [], @@ -53258,6 +53912,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/reference/teams#update-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/teams#update-a-discussion-legacy", "previews": [], @@ -53337,6 +53992,7 @@ "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "documentationUrl": "https://docs.github.com/rest/reference/teams#update-a-team", "previews": [], @@ -53455,6 +54111,7 @@ "url": "/teams/{team_id}", "isDeprecated": true, "deprecationDate": "2020-01-21", + "removalDate": "2021-02-01", "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/reference/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", "documentationUrl": "https://docs.github.com/rest/reference/teams/#update-a-team-legacy", "previews": [], @@ -53572,6 +54229,7 @@ "url": "/user/emails", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint is accessible with the `user` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user", "previews": [], @@ -53621,6 +54279,7 @@ "url": "/user/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/users#block-a-user", "previews": [], @@ -53662,6 +54321,7 @@ "url": "/user/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user", "previews": [], @@ -53710,6 +54370,7 @@ "url": "/users/{username}/following/{target_user}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user", "previews": [], @@ -53764,6 +54425,7 @@ "url": "/user/following/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user", "previews": [], @@ -53812,6 +54474,7 @@ "url": "/user/gpg_keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", "previews": [], @@ -53861,6 +54524,7 @@ "url": "/user/keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", "previews": [], @@ -53923,6 +54587,7 @@ "url": "/user/emails", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "This endpoint is accessible with the `user` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user", "previews": [], @@ -53964,6 +54629,7 @@ "url": "/user/gpg_keys/{gpg_key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", "previews": [], @@ -54005,6 +54671,7 @@ "url": "/user/keys/{key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", "previews": [], @@ -54045,6 +54712,7 @@ "url": "/user/following/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#follow-a-user", "previews": [], @@ -54085,6 +54753,7 @@ "url": "/user", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "If the authenticated user is authenticated through basic authentication or OAuth with the `user` scope, then the response lists public and private profile information.\n\nIf the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information.", "documentationUrl": "https://docs.github.com/rest/reference/users#get-the-authenticated-user", "previews": [], @@ -54121,6 +54790,7 @@ "url": "/users/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Provides publicly available information about someone with a GitHub account.\n\nGitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://docs.github.com/rest/reference/users#emails)\".", "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-user", "previews": [], @@ -54166,6 +54836,7 @@ "url": "/users/{username}/hovercard", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```", "documentationUrl": "https://docs.github.com/rest/reference/users#get-contextual-information-for-a-user", "previews": [], @@ -54234,6 +54905,7 @@ "url": "/user/gpg_keys/{gpg_key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", "previews": [], @@ -54282,6 +54954,7 @@ "url": "/user/keys/{key_id}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", "previews": [], @@ -54330,6 +55003,7 @@ "url": "/users", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-users", "previews": [], @@ -54384,6 +55058,7 @@ "url": "/user/blocks", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "List the users you've blocked on your personal account.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user", "previews": [], @@ -54419,6 +55094,7 @@ "url": "/user/emails", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user", "previews": [], @@ -54480,6 +55156,7 @@ "url": "/user/following", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people who the authenticated user follows.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows", "previews": [], @@ -54540,6 +55217,7 @@ "url": "/user/followers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people following the authenticated user.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user", "previews": [], @@ -54600,6 +55278,7 @@ "url": "/users/{username}/followers", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people following the specified user.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-followers-of-a-user", "previews": [], @@ -54666,6 +55345,7 @@ "url": "/users/{username}/following", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the people who the specified user follows.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-the-people-a-user-follows", "previews": [], @@ -54732,6 +55412,7 @@ "url": "/user/gpg_keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user", "previews": [], @@ -54793,6 +55474,7 @@ "url": "/users/{username}/gpg_keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the GPG keys for a user. This information is accessible by anyone.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user", "previews": [], @@ -54859,6 +55541,7 @@ "url": "/user/public_emails", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", "previews": [], @@ -54920,6 +55603,7 @@ "url": "/users/{username}/keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-keys-for-a-user", "previews": [], @@ -54982,6 +55666,7 @@ "url": "/user/keys", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", "previews": [], @@ -55043,6 +55728,7 @@ "url": "/user/email/visibility", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Sets the visibility for your primary email addresses.", "documentationUrl": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user", "previews": [], @@ -55092,6 +55778,7 @@ "url": "/user/blocks/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "", "documentationUrl": "https://docs.github.com/rest/reference/users#unblock-a-user", "previews": [], @@ -55132,6 +55819,7 @@ "url": "/user/following/{username}", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", "documentationUrl": "https://docs.github.com/rest/reference/users#unfollow-a-user", "previews": [], @@ -55172,6 +55860,7 @@ "url": "/user", "isDeprecated": false, "deprecationDate": null, + "removalDate": null, "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", "documentationUrl": "https://docs.github.com/rest/reference/users/#update-the-authenticated-user", "previews": [], diff --git a/scripts/update-endpoints/util.js b/scripts/update-endpoints/util.js index 5dbf8d9a2..bda8a7a42 100644 --- a/scripts/update-endpoints/util.js +++ b/scripts/update-endpoints/util.js @@ -1,5 +1,5 @@ module.exports = { - isDeprecated + isDeprecated, }; /** @@ -7,7 +7,15 @@ module.exports = { * @param { Endpoint } endpoint */ function isDeprecated(endpoint) { - const deprecated = endpoint.isLegacy || endpoint.isDeprecated; + if ( + endpoint.removalDate && + endpoint.removalDate < new Date().toISOString().substr(0, 10) + ) { + return true; + } + + const deprecated = + !endpoint.removalDate && (endpoint.isLegacy || endpoint.isDeprecated); if (!deprecated) { return false; diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 0a94f37e3..73c262d82 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -352,10 +352,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { codesOfConduct: { getAllCodesOfConduct: ["GET /codes_of_conduct"], getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - ], }, emojis: { get: ["GET /emojis"] }, enterpriseAdmin: { @@ -805,87 +801,58 @@ const Endpoints: EndpointsDefaultsAndDecorations = { reactions: { createForCommitComment: [ "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForIssue: [ "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForIssueComment: [ "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForPullRequestReviewComment: [ "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForRelease: [ "POST /repos/{owner}/{repo}/releases/{release_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForTeamDiscussionCommentInOrg: [ "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], createForTeamDiscussionInOrg: [ "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForCommitComment: [ "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForIssue: [ "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForIssueComment: [ "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForPullRequestComment: [ "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForTeamDiscussion: [ "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, ], deleteForTeamDiscussionComment: [ "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, - ], - deleteLegacy: [ - "DELETE /reactions/{reaction_id}", - { mediaType: { previews: ["squirrel-girl"] } }, - { - deprecated: - "octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy", - }, ], listForCommitComment: [ "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, - ], - listForIssue: [ - "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], + listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"], listForIssueComment: [ "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], listForPullRequestReviewComment: [ "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], listForTeamDiscussionCommentInOrg: [ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], listForTeamDiscussionInOrg: [ "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - { mediaType: { previews: ["squirrel-girl"] } }, ], }, repos: { diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index cc13e0964..d0ff3920b 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -2601,20 +2601,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Returns the contents of the repository's code of conduct file, if one is detected. - * - * A code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching. - */ - getForRepo: { - ( - params?: RestEndpointMethodTypes["codesOfConduct"]["getForRepo"]["parameters"] - ): Promise< - RestEndpointMethodTypes["codesOfConduct"]["getForRepo"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; }; emojis: { /** @@ -5882,21 +5868,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/). - * - * OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/rest/reference/teams#discussion-comments). - * @deprecated octokit.rest.reactions.deleteLegacy() is deprecated, see https://docs.github.com/rest/reference/reactions/#delete-a-reaction-legacy - */ - deleteLegacy: { - ( - params?: RestEndpointMethodTypes["reactions"]["deleteLegacy"]["parameters"] - ): Promise< - RestEndpointMethodTypes["reactions"]["deleteLegacy"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). */ @@ -6828,8 +6799,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file. - * * The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. */ get: { diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index 596df7a95..0b5b32883 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -1366,14 +1366,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /codes_of_conduct/{key}"]["response"]; }; - getForRepo: { - parameters: RequestParameters & - Omit< - Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /repos/{owner}/{repo}/community/code_of_conduct"]["response"]; - }; }; emojis: { get: { @@ -3488,14 +3480,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"]["response"]; }; - deleteLegacy: { - parameters: RequestParameters & - Omit< - Endpoints["DELETE /reactions/{reaction_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["DELETE /reactions/{reaction_id}"]["response"]; - }; listForCommitComment: { parameters: RequestParameters & Omit<