diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md index 6c03bd0c4..2e43cb5fe 100644 --- a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md @@ -11,6 +11,9 @@ type: API method Add custom labels to a self-hosted runner configured in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ @@ -49,4 +52,4 @@ The names of the custom labels to add to the runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md index f84f99f18..ad9141c4d 100644 --- a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md +++ b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md @@ -10,8 +10,10 @@ type: API method Add custom labels to a self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ @@ -56,4 +58,4 @@ The names of the custom labels to add to the runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/addSelectedRepoToOrgSecret.md b/docs/actions/addSelectedRepoToOrgSecret.md index 9bc3aaf7d..1499e860d 100644 --- a/docs/actions/addSelectedRepoToOrgSecret.md +++ b/docs/actions/addSelectedRepoToOrgSecret.md @@ -8,7 +8,14 @@ type: API method # Add selected repository to an organization secret -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. +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/actions/secrets#create-or-update-an-organization-secret). + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.addSelectedRepoToOrgSecret({ @@ -45,4 +52,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-selected-repository-to-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret). diff --git a/docs/actions/addSelectedRepoToOrgVariable.md b/docs/actions/addSelectedRepoToOrgVariable.md index 38097cfb9..ad8cf28a4 100644 --- a/docs/actions/addSelectedRepoToOrgVariable.md +++ b/docs/actions/addSelectedRepoToOrgVariable.md @@ -8,7 +8,13 @@ type: API method # Add selected repository to an organization variable -Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Adds a repository to an organization variable that is available to selected repositories. +Organization variables that are available to selected repositories have their `visibility` field set to `selected`. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.addSelectedRepoToOrgVariable({ diff --git a/docs/actions/addSelectedRepoToRequiredWorkflow.md b/docs/actions/addSelectedRepoToRequiredWorkflow.md deleted file mode 100644 index b9ae6e172..000000000 --- a/docs/actions/addSelectedRepoToRequiredWorkflow.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Add a repository to a required workflow -example: octokit.rest.actions.addSelectedRepoToRequiredWorkflow({ org, required_workflow_id, repository_id }) -route: PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id} -scope: actions -type: API method ---- - -# Add a repository to a required workflow - -Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.addSelectedRepoToRequiredWorkflow({ - org, - required_workflow_id, - repository_id, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
repository_idyes - -The unique identifier of the repository. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-a-repository-to-selected-repositories-list-for-a-required-workflow). diff --git a/docs/actions/approveWorkflowRun.md b/docs/actions/approveWorkflowRun.md index 250a038e3..4db622255 100644 --- a/docs/actions/approveWorkflowRun.md +++ b/docs/actions/approveWorkflowRun.md @@ -49,4 +49,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request). diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md index 6f5064599..5adaf5ffb 100644 --- a/docs/actions/cancelWorkflowRun.md +++ b/docs/actions/cancelWorkflowRun.md @@ -8,7 +8,11 @@ type: API method # Cancel a workflow run -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. +Cancels a workflow run using its `id`. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `actions:write` permission to use this endpoint. ```js octokit.rest.actions.cancelWorkflowRun({ @@ -47,4 +51,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#cancel-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run). diff --git a/docs/actions/createEnvironmentVariable.md b/docs/actions/createEnvironmentVariable.md index dc6b8a2cf..7fc653630 100644 --- a/docs/actions/createEnvironmentVariable.md +++ b/docs/actions/createEnvironmentVariable.md @@ -9,8 +9,11 @@ type: API method # Create an environment variable Create an environment variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.createEnvironmentVariable({ diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md index 67f78a60c..b4785a0f4 100644 --- a/docs/actions/createOrUpdateEnvironmentSecret.md +++ b/docs/actions/createOrUpdateEnvironmentSecret.md @@ -9,81 +9,11 @@ type: API method # Create or update an environment secret Creates or updates an environment secret with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -**Example encrypting a secret using Node.js** - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -**Example encrypting a secret using Python** - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -**Example encrypting a secret using C#** - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` - -**Example encrypting a secret using Ruby** - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.createOrUpdateEnvironmentSecret({ @@ -123,7 +53,7 @@ The name of the secret. 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. +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/actions/secrets#get-an-environment-public-key) endpoint. key_idyes @@ -134,4 +64,4 @@ ID of the key you used to encrypt the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret). diff --git a/docs/actions/createOrUpdateRepoSecret.md b/docs/actions/createOrUpdateRepoSecret.md index 5ff3a0396..6eb975a8c 100644 --- a/docs/actions/createOrUpdateRepoSecret.md +++ b/docs/actions/createOrUpdateRepoSecret.md @@ -9,81 +9,11 @@ type: API method # Create or update a repository secret Creates or updates a repository secret with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -**Example encrypting a secret using Node.js** - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -**Example encrypting a secret using Python** - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -**Example encrypting a secret using C#** - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` - -**Example encrypting a secret using Ruby** - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.createOrUpdateRepoSecret({ @@ -121,7 +51,7 @@ The name of the secret. encrypted_valueno -Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint. +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. key_idno @@ -132,4 +62,4 @@ ID of the key you used to encrypt the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret). diff --git a/docs/actions/createOrgVariable.md b/docs/actions/createOrgVariable.md index 86796d6c5..1273d70a8 100644 --- a/docs/actions/createOrgVariable.md +++ b/docs/actions/createOrgVariable.md @@ -9,8 +9,11 @@ type: API method # Create an organization variable Creates an organization variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.createOrgVariable({ diff --git a/docs/actions/createRegistrationTokenForOrg.md b/docs/actions/createRegistrationTokenForOrg.md index 0129efea6..788936c26 100644 --- a/docs/actions/createRegistrationTokenForOrg.md +++ b/docs/actions/createRegistrationTokenForOrg.md @@ -11,8 +11,11 @@ type: API method Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. -#### Example using registration token +Example using registration token: Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. @@ -45,4 +48,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-registration-token-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization). diff --git a/docs/actions/createRegistrationTokenForRepo.md b/docs/actions/createRegistrationTokenForRepo.md index ed336bac2..8f159a3aa 100644 --- a/docs/actions/createRegistrationTokenForRepo.md +++ b/docs/actions/createRegistrationTokenForRepo.md @@ -8,16 +8,20 @@ type: API method # Create a registration token for a repository -Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate -using an access token with the `repo` scope to use this endpoint. +Returns a token that you can pass to the `config` script. The token +expires after one hour. -#### Example using registration token +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. -Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. +Example using registration token: -``` -./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN -``` +Configure your self-hosted runner, replacing `TOKEN` with the registration token provided +by this endpoint. + +`config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN` ```js octokit.rest.actions.createRegistrationTokenForRepo({ @@ -50,4 +54,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-registration-token-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository). diff --git a/docs/actions/createRemoveTokenForOrg.md b/docs/actions/createRemoveTokenForOrg.md index 3b6ac8855..276dc1e7f 100644 --- a/docs/actions/createRemoveTokenForOrg.md +++ b/docs/actions/createRemoveTokenForOrg.md @@ -11,8 +11,11 @@ type: API method 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. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. -#### Example using remove token +Example using remove token: To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this endpoint. @@ -46,4 +49,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-remove-token-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization). diff --git a/docs/actions/createRemoveTokenForRepo.md b/docs/actions/createRemoveTokenForRepo.md index 0bca0a3ae..9e2fa22fe 100644 --- a/docs/actions/createRemoveTokenForRepo.md +++ b/docs/actions/createRemoveTokenForRepo.md @@ -8,16 +8,20 @@ type: API method # Create a remove token for a repository -Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. +Returns a token that you can pass to remove a self-hosted runner from +a repository. The token expires after one hour. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. -#### Example using remove token +Example using remove token: -To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. +To remove your self-hosted runner from a repository, replace TOKEN with +the remove token provided by this endpoint. -``` -./config.sh remove --token TOKEN -``` +`config.sh remove --token TOKEN` ```js octokit.rest.actions.createRemoveTokenForRepo({ @@ -50,4 +54,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-remove-token-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository). diff --git a/docs/actions/createRepoVariable.md b/docs/actions/createRepoVariable.md index 2356c6ee6..ccb6f6b60 100644 --- a/docs/actions/createRepoVariable.md +++ b/docs/actions/createRepoVariable.md @@ -9,8 +9,11 @@ type: API method # Create a repository variable Creates a repository variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.createRepoVariable({ diff --git a/docs/actions/createRequiredWorkflow.md b/docs/actions/createRequiredWorkflow.md deleted file mode 100644 index b8653d37d..000000000 --- a/docs/actions/createRequiredWorkflow.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -name: Create a required workflow -example: octokit.rest.actions.createRequiredWorkflow({ org, workflow_file_path, repository_id }) -route: POST /orgs/{org}/actions/required_workflows -scope: actions -type: API method ---- - -# Create a required workflow - -Create a required workflow in an organization. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.createRequiredWorkflow({ - org, - workflow_file_path, - repository_id, -}); -``` - -## Parameters - - - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
workflow_file_pathyes - -Path of the workflow file to be configured as a required workflow. - -
repository_idyes - -The ID of the repository that contains the workflow file. - -
scopeno - -Enable the required workflow for all repositories or selected repositories in the organization. - -
selected_repository_idsno - -A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-required-workflow). diff --git a/docs/actions/createWorkflowDispatch.md b/docs/actions/createWorkflowDispatch.md index 440f0fb47..9a579a042 100644 --- a/docs/actions/createWorkflowDispatch.md +++ b/docs/actions/createWorkflowDispatch.md @@ -65,4 +65,4 @@ Input keys and values configured in the workflow file. The maximum number of pro -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event). diff --git a/docs/actions/deleteArtifact.md b/docs/actions/deleteArtifact.md index 24e772011..444d083b2 100644 --- a/docs/actions/deleteArtifact.md +++ b/docs/actions/deleteArtifact.md @@ -47,4 +47,4 @@ The unique identifier of the artifact. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-an-artifact). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/artifacts#delete-an-artifact). diff --git a/docs/actions/deleteEnvironmentSecret.md b/docs/actions/deleteEnvironmentSecret.md index ff8f0451d..906cde809 100644 --- a/docs/actions/deleteEnvironmentSecret.md +++ b/docs/actions/deleteEnvironmentSecret.md @@ -8,7 +8,11 @@ type: API method # Delete an environment secret -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.deleteEnvironmentSecret({ @@ -47,4 +51,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-an-environment-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#delete-an-environment-secret). diff --git a/docs/actions/deleteEnvironmentVariable.md b/docs/actions/deleteEnvironmentVariable.md index 0fc8a8836..abc159cc4 100644 --- a/docs/actions/deleteEnvironmentVariable.md +++ b/docs/actions/deleteEnvironmentVariable.md @@ -9,8 +9,11 @@ type: API method # Delete an environment variable Deletes an environment variable using the variable name. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.deleteEnvironmentVariable({ diff --git a/docs/actions/deleteOrgSecret.md b/docs/actions/deleteOrgSecret.md index 52af6d1d6..0d6711e3b 100644 --- a/docs/actions/deleteOrgSecret.md +++ b/docs/actions/deleteOrgSecret.md @@ -8,7 +8,12 @@ type: API method # Delete an organization secret -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. +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. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.deleteOrgSecret({ @@ -41,4 +46,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#delete-an-organization-secret). diff --git a/docs/actions/deleteOrgVariable.md b/docs/actions/deleteOrgVariable.md index 93667d1ff..67907a535 100644 --- a/docs/actions/deleteOrgVariable.md +++ b/docs/actions/deleteOrgVariable.md @@ -9,8 +9,11 @@ type: API method # Delete an organization variable Deletes an organization variable using the variable name. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.deleteOrgVariable({ diff --git a/docs/actions/deleteRepoSecret.md b/docs/actions/deleteRepoSecret.md index 7c8dd68a1..43720b542 100644 --- a/docs/actions/deleteRepoSecret.md +++ b/docs/actions/deleteRepoSecret.md @@ -8,7 +8,11 @@ type: API method # Delete a repository secret -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.deleteRepoSecret({ @@ -47,4 +51,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#delete-a-repository-secret). diff --git a/docs/actions/deleteRepoVariable.md b/docs/actions/deleteRepoVariable.md index b2e4fbdd9..974c4f10a 100644 --- a/docs/actions/deleteRepoVariable.md +++ b/docs/actions/deleteRepoVariable.md @@ -9,8 +9,11 @@ type: API method # Delete a repository variable Deletes a repository variable using the variable name. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.deleteRepoVariable({ diff --git a/docs/actions/deleteRequiredWorkflow.md b/docs/actions/deleteRequiredWorkflow.md deleted file mode 100644 index ba6da21d8..000000000 --- a/docs/actions/deleteRequiredWorkflow.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: Delete a required workflow -example: octokit.rest.actions.deleteRequiredWorkflow({ org, required_workflow_id }) -route: DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id} -scope: actions -type: API method ---- - -# Delete a required workflow - -Deletes a required workflow configured in an organization. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.deleteRequiredWorkflow({ - org, - required_workflow_id, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-a-required-workflow). diff --git a/docs/actions/deleteSelfHostedRunnerFromOrg.md b/docs/actions/deleteSelfHostedRunnerFromOrg.md index 7a7f5c325..4e1b4caeb 100644 --- a/docs/actions/deleteSelfHostedRunnerFromOrg.md +++ b/docs/actions/deleteSelfHostedRunnerFromOrg.md @@ -11,6 +11,9 @@ type: API method 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. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.deleteSelfHostedRunnerFromOrg({ @@ -43,4 +46,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization). diff --git a/docs/actions/deleteSelfHostedRunnerFromRepo.md b/docs/actions/deleteSelfHostedRunnerFromRepo.md index f386f5356..c10b6bfa7 100644 --- a/docs/actions/deleteSelfHostedRunnerFromRepo.md +++ b/docs/actions/deleteSelfHostedRunnerFromRepo.md @@ -10,8 +10,10 @@ type: API method 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. -You must authenticate using an access token with the `repo` -scope to use this endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.deleteSelfHostedRunnerFromRepo({ @@ -50,4 +52,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository). diff --git a/docs/actions/deleteWorkflowRun.md b/docs/actions/deleteWorkflowRun.md index 731041bac..7f7b24d48 100644 --- a/docs/actions/deleteWorkflowRun.md +++ b/docs/actions/deleteWorkflowRun.md @@ -49,4 +49,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run). diff --git a/docs/actions/deleteWorkflowRunLogs.md b/docs/actions/deleteWorkflowRunLogs.md index 0073625a5..9bdd3b45a 100644 --- a/docs/actions/deleteWorkflowRunLogs.md +++ b/docs/actions/deleteWorkflowRunLogs.md @@ -47,4 +47,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#delete-workflow-run-logs). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs). diff --git a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md index 08953dc21..4b7529252 100644 --- a/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/disableSelectedRepositoryGithubActionsOrganization.md @@ -43,4 +43,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization). diff --git a/docs/actions/disableWorkflow.md b/docs/actions/disableWorkflow.md index a3dee4ad7..7c112b8c6 100644 --- a/docs/actions/disableWorkflow.md +++ b/docs/actions/disableWorkflow.md @@ -49,4 +49,4 @@ The ID of the workflow. You can also pass the workflow file name as a string. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#disable-a-workflow). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#disable-a-workflow). diff --git a/docs/actions/downloadArtifact.md b/docs/actions/downloadArtifact.md index 223bf7ef3..9a0243621 100644 --- a/docs/actions/downloadArtifact.md +++ b/docs/actions/downloadArtifact.md @@ -9,8 +9,9 @@ type: API method # Download an artifact Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in -the response header to find the URL for the download. The `:archive_format` must be `zip`. 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. +the response header to find the URL for the download. The `:archive_format` must be `zip`. + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:read` permission to use this endpoint. ```js @@ -54,4 +55,4 @@ The unique identifier of the artifact. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#download-an-artifact). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/artifacts#download-an-artifact). diff --git a/docs/actions/downloadJobLogsForWorkflowRun.md b/docs/actions/downloadJobLogsForWorkflowRun.md index 2f2347cc8..4231a2f78 100644 --- a/docs/actions/downloadJobLogsForWorkflowRun.md +++ b/docs/actions/downloadJobLogsForWorkflowRun.md @@ -50,4 +50,4 @@ The unique identifier of the job. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run). diff --git a/docs/actions/downloadWorkflowRunAttemptLogs.md b/docs/actions/downloadWorkflowRunAttemptLogs.md index 041e563c1..8b622e14b 100644 --- a/docs/actions/downloadWorkflowRunAttemptLogs.md +++ b/docs/actions/downloadWorkflowRunAttemptLogs.md @@ -56,4 +56,4 @@ The attempt number of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs). diff --git a/docs/actions/downloadWorkflowRunLogs.md b/docs/actions/downloadWorkflowRunLogs.md index 6ccee6e1d..638500567 100644 --- a/docs/actions/downloadWorkflowRunLogs.md +++ b/docs/actions/downloadWorkflowRunLogs.md @@ -50,4 +50,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#download-workflow-run-logs). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs). diff --git a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md index 09b2b68db..d32e6da6b 100644 --- a/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md +++ b/docs/actions/enableSelectedRepositoryGithubActionsOrganization.md @@ -43,4 +43,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization). diff --git a/docs/actions/enableWorkflow.md b/docs/actions/enableWorkflow.md index 48ab98fe5..eaac37397 100644 --- a/docs/actions/enableWorkflow.md +++ b/docs/actions/enableWorkflow.md @@ -49,4 +49,4 @@ The ID of the workflow. You can also pass the workflow file name as a string. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#enable-a-workflow). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#enable-a-workflow). diff --git a/docs/actions/generateRunnerJitconfigForOrg.md b/docs/actions/generateRunnerJitconfigForOrg.md index 09e1ccc27..0fd978aca 100644 --- a/docs/actions/generateRunnerJitconfigForOrg.md +++ b/docs/actions/generateRunnerJitconfigForOrg.md @@ -11,6 +11,9 @@ type: API method Generates a configuration that can be passed to the runner application at startup. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.generateRunnerJitconfigForOrg({ diff --git a/docs/actions/generateRunnerJitconfigForRepo.md b/docs/actions/generateRunnerJitconfigForRepo.md index b0ee0e61f..52f59cf64 100644 --- a/docs/actions/generateRunnerJitconfigForRepo.md +++ b/docs/actions/generateRunnerJitconfigForRepo.md @@ -11,6 +11,9 @@ type: API method Generates a configuration that can be passed to the runner application at startup. You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.generateRunnerJitconfigForRepo({ diff --git a/docs/actions/getActionsCacheUsage.md b/docs/actions/getActionsCacheUsage.md index eac244354..5a40969de 100644 --- a/docs/actions/getActionsCacheUsage.md +++ b/docs/actions/getActionsCacheUsage.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository). diff --git a/docs/actions/getActionsCacheUsageByRepoForOrg.md b/docs/actions/getActionsCacheUsageByRepoForOrg.md index 2b13cdfb4..665e99e6f 100644 --- a/docs/actions/getActionsCacheUsageByRepoForOrg.md +++ b/docs/actions/getActionsCacheUsageByRepoForOrg.md @@ -47,4 +47,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization). diff --git a/docs/actions/getActionsCacheUsageForOrg.md b/docs/actions/getActionsCacheUsageForOrg.md index 678f3fda2..8a41ad6c8 100644 --- a/docs/actions/getActionsCacheUsageForOrg.md +++ b/docs/actions/getActionsCacheUsageForOrg.md @@ -37,4 +37,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization). diff --git a/docs/actions/getAllowedActionsOrganization.md b/docs/actions/getAllowedActionsOrganization.md index 6f8851097..db960d6a8 100644 --- a/docs/actions/getAllowedActionsOrganization.md +++ b/docs/actions/getAllowedActionsOrganization.md @@ -37,4 +37,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization). diff --git a/docs/actions/getAllowedActionsRepository.md b/docs/actions/getAllowedActionsRepository.md index b8f510de6..fed8545e9 100644 --- a/docs/actions/getAllowedActionsRepository.md +++ b/docs/actions/getAllowedActionsRepository.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-allowed-actions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository). diff --git a/docs/actions/getArtifact.md b/docs/actions/getArtifact.md index 7926d141f..9651d4d19 100644 --- a/docs/actions/getArtifact.md +++ b/docs/actions/getArtifact.md @@ -47,4 +47,4 @@ The unique identifier of the artifact. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-an-artifact). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/artifacts#get-an-artifact). diff --git a/docs/actions/getEnvironmentPublicKey.md b/docs/actions/getEnvironmentPublicKey.md index 39db91812..ce62624ed 100644 --- a/docs/actions/getEnvironmentPublicKey.md +++ b/docs/actions/getEnvironmentPublicKey.md @@ -8,7 +8,13 @@ type: API method # Get an environment public key -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getEnvironmentPublicKey({ @@ -41,4 +47,4 @@ The name of the environment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-an-environment-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key). diff --git a/docs/actions/getEnvironmentSecret.md b/docs/actions/getEnvironmentSecret.md index f3d1251f5..e33351474 100644 --- a/docs/actions/getEnvironmentSecret.md +++ b/docs/actions/getEnvironmentSecret.md @@ -8,7 +8,11 @@ type: API method # Get an environment secret -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getEnvironmentSecret({ @@ -47,4 +51,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-an-environment-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-an-environment-secret). diff --git a/docs/actions/getEnvironmentVariable.md b/docs/actions/getEnvironmentVariable.md index 9d9db37e0..58fc08a2a 100644 --- a/docs/actions/getEnvironmentVariable.md +++ b/docs/actions/getEnvironmentVariable.md @@ -8,7 +8,12 @@ type: API method # Get an environment variable -Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint. +Gets a specific variable in an environment. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `environments:read` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.getEnvironmentVariable({ diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md index a94be742f..7e747ad07 100644 --- a/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -39,4 +39,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-default-workflow-permissions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization). diff --git a/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md index 7d8816a10..7f032e3b9 100644 --- a/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md +++ b/docs/actions/getGithubActionsDefaultWorkflowPermissionsRepository.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository). diff --git a/docs/actions/getGithubActionsPermissionsOrganization.md b/docs/actions/getGithubActionsPermissionsOrganization.md index 42fedadd4..cd0b95737 100644 --- a/docs/actions/getGithubActionsPermissionsOrganization.md +++ b/docs/actions/getGithubActionsPermissionsOrganization.md @@ -37,4 +37,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization). diff --git a/docs/actions/getGithubActionsPermissionsRepository.md b/docs/actions/getGithubActionsPermissionsRepository.md index 330d20c9e..33f1a04d8 100644 --- a/docs/actions/getGithubActionsPermissionsRepository.md +++ b/docs/actions/getGithubActionsPermissionsRepository.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository). diff --git a/docs/actions/getJobForWorkflowRun.md b/docs/actions/getJobForWorkflowRun.md index 9a8754af2..c63e93c8b 100644 --- a/docs/actions/getJobForWorkflowRun.md +++ b/docs/actions/getJobForWorkflowRun.md @@ -47,4 +47,4 @@ The unique identifier of the job. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-job-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run). diff --git a/docs/actions/getOrgPublicKey.md b/docs/actions/getOrgPublicKey.md index 950e2835d..ff6a63d4a 100644 --- a/docs/actions/getOrgPublicKey.md +++ b/docs/actions/getOrgPublicKey.md @@ -8,7 +8,13 @@ type: API method # Get an organization public key -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. +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. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getOrgPublicKey({ @@ -35,4 +41,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-an-organization-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key). diff --git a/docs/actions/getOrgSecret.md b/docs/actions/getOrgSecret.md index d07883b44..02c161737 100644 --- a/docs/actions/getOrgSecret.md +++ b/docs/actions/getOrgSecret.md @@ -8,7 +8,12 @@ type: API method # Get an organization secret -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. +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. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getOrgSecret({ @@ -41,4 +46,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-an-organization-secret). diff --git a/docs/actions/getOrgVariable.md b/docs/actions/getOrgVariable.md index 7f7ea4a74..3374e4b70 100644 --- a/docs/actions/getOrgVariable.md +++ b/docs/actions/getOrgVariable.md @@ -8,7 +8,12 @@ type: API method # Get an organization variable -Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. +Gets a specific variable in an organization. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.getOrgVariable({ diff --git a/docs/actions/getPendingDeploymentsForRun.md b/docs/actions/getPendingDeploymentsForRun.md index 9304fd5cf..068211bf5 100644 --- a/docs/actions/getPendingDeploymentsForRun.md +++ b/docs/actions/getPendingDeploymentsForRun.md @@ -49,4 +49,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-pending-deployments-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run). diff --git a/docs/actions/getRepoPermissions.md b/docs/actions/getRepoPermissions.md index 423f214bc..9accd653f 100644 --- a/docs/actions/getRepoPermissions.md +++ b/docs/actions/getRepoPermissions.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository). diff --git a/docs/actions/getRepoPublicKey.md b/docs/actions/getRepoPublicKey.md index 9c2063333..3aed36d1b 100644 --- a/docs/actions/getRepoPublicKey.md +++ b/docs/actions/getRepoPublicKey.md @@ -8,7 +8,13 @@ type: API method # Get a repository public key -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getRepoPublicKey({ @@ -41,4 +47,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-repository-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key). diff --git a/docs/actions/getRepoRequiredWorkflow.md b/docs/actions/getRepoRequiredWorkflow.md deleted file mode 100644 index f2648f2bd..000000000 --- a/docs/actions/getRepoRequiredWorkflow.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Get a required workflow entity for a repository -example: octokit.rest.actions.getRepoRequiredWorkflow({ org, repo, required_workflow_id_for_repo }) -route: GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo} -scope: actions -type: API method ---- - -# Get a required workflow entity for a repository - -Gets a specific required workflow present 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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.getRepoRequiredWorkflow({ - org, - repo, - required_workflow_id_for_repo, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
required_workflow_id_for_repoyes - -The ID of the required workflow that has run at least once in a repository. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-repository-required-workflow). diff --git a/docs/actions/getRepoRequiredWorkflowUsage.md b/docs/actions/getRepoRequiredWorkflowUsage.md deleted file mode 100644 index 001b3f9d2..000000000 --- a/docs/actions/getRepoRequiredWorkflowUsage.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Get required workflow usage -example: octokit.rest.actions.getRepoRequiredWorkflowUsage({ org, repo, required_workflow_id_for_repo }) -route: GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing -scope: actions -type: API method ---- - -# Get required workflow usage - -Gets the number of billable minutes used by a specific required workflow during the current billing cycle. - -Billable minutes only apply to required workflows running 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)." - -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. - -```js -octokit.rest.actions.getRepoRequiredWorkflowUsage({ - org, - repo, - required_workflow_id_for_repo, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
required_workflow_id_for_repoyes - -The ID of the required workflow that has run at least once in a repository. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-repository-required-workflow-usage). diff --git a/docs/actions/getRepoSecret.md b/docs/actions/getRepoSecret.md index 70cfdcffa..50125f83b 100644 --- a/docs/actions/getRepoSecret.md +++ b/docs/actions/getRepoSecret.md @@ -8,7 +8,11 @@ type: API method # Get a repository secret -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.getRepoSecret({ @@ -47,4 +51,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#get-a-repository-secret). diff --git a/docs/actions/getRepoVariable.md b/docs/actions/getRepoVariable.md index 11ec848f5..d64710ca5 100644 --- a/docs/actions/getRepoVariable.md +++ b/docs/actions/getRepoVariable.md @@ -8,7 +8,12 @@ type: API method # Get a repository variable -Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Gets a specific variable in a repository. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.getRepoVariable({ diff --git a/docs/actions/getRequiredWorkflow.md b/docs/actions/getRequiredWorkflow.md deleted file mode 100644 index 68d5c8625..000000000 --- a/docs/actions/getRequiredWorkflow.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: Get a required workflow -example: octokit.rest.actions.getRequiredWorkflow({ org, required_workflow_id }) -route: GET /orgs/{org}/actions/required_workflows/{required_workflow_id} -scope: actions -type: API method ---- - -# Get a required workflow - -Get a required workflow configured in an organization. - -You must authenticate using an access token with the `read:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.getRequiredWorkflow({ - org, - required_workflow_id, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-required-workflow). diff --git a/docs/actions/getReviewsForRun.md b/docs/actions/getReviewsForRun.md index 2723c3409..9c1848f99 100644 --- a/docs/actions/getReviewsForRun.md +++ b/docs/actions/getReviewsForRun.md @@ -47,4 +47,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run). diff --git a/docs/actions/getSelfHostedRunnerForOrg.md b/docs/actions/getSelfHostedRunnerForOrg.md index 483557212..c34445776 100644 --- a/docs/actions/getSelfHostedRunnerForOrg.md +++ b/docs/actions/getSelfHostedRunnerForOrg.md @@ -11,6 +11,9 @@ type: API method Gets a specific self-hosted runner configured in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.getSelfHostedRunnerForOrg({ @@ -43,4 +46,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/getSelfHostedRunnerForRepo.md b/docs/actions/getSelfHostedRunnerForRepo.md index b3037eaff..02926142d 100644 --- a/docs/actions/getSelfHostedRunnerForRepo.md +++ b/docs/actions/getSelfHostedRunnerForRepo.md @@ -10,8 +10,10 @@ type: API method Gets a specific self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.getSelfHostedRunnerForRepo({ @@ -50,4 +52,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/getWorkflow.md b/docs/actions/getWorkflow.md index da40e1af0..effbcc1bd 100644 --- a/docs/actions/getWorkflow.md +++ b/docs/actions/getWorkflow.md @@ -47,4 +47,4 @@ The ID of the workflow. You can also pass the workflow file name as a string. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-workflow). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#get-a-workflow). diff --git a/docs/actions/getWorkflowAccessToRepository.md b/docs/actions/getWorkflowAccessToRepository.md index d0f15fcaf..104452c52 100644 --- a/docs/actions/getWorkflowAccessToRepository.md +++ b/docs/actions/getWorkflowAccessToRepository.md @@ -46,4 +46,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository). diff --git a/docs/actions/getWorkflowRun.md b/docs/actions/getWorkflowRun.md index 768ad6b9f..117871f92 100644 --- a/docs/actions/getWorkflowRun.md +++ b/docs/actions/getWorkflowRun.md @@ -52,4 +52,4 @@ If `true` pull requests are omitted from the response (empty array). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run). diff --git a/docs/actions/getWorkflowRunAttempt.md b/docs/actions/getWorkflowRunAttempt.md index 364f0bd61..cc35b1bed 100644 --- a/docs/actions/getWorkflowRunAttempt.md +++ b/docs/actions/getWorkflowRunAttempt.md @@ -61,4 +61,4 @@ If `true` pull requests are omitted from the response (empty array). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt). diff --git a/docs/actions/getWorkflowRunUsage.md b/docs/actions/getWorkflowRunUsage.md index 3c1d97990..11e10603c 100644 --- a/docs/actions/getWorkflowRunUsage.md +++ b/docs/actions/getWorkflowRunUsage.md @@ -49,4 +49,4 @@ The unique identifier of the workflow run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-workflow-run-usage). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage). diff --git a/docs/actions/getWorkflowUsage.md b/docs/actions/getWorkflowUsage.md index 78e0dfdbc..b56ff7675 100644 --- a/docs/actions/getWorkflowUsage.md +++ b/docs/actions/getWorkflowUsage.md @@ -49,4 +49,4 @@ The ID of the workflow. You can also pass the workflow file name as a string. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#get-workflow-usage). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#get-workflow-usage). diff --git a/docs/actions/listArtifactsForRepo.md b/docs/actions/listArtifactsForRepo.md index a9044c910..467a590f6 100644 --- a/docs/actions/listArtifactsForRepo.md +++ b/docs/actions/listArtifactsForRepo.md @@ -50,10 +50,10 @@ Page number of the results to fetch. nameno -Filters artifacts by exact match on their name field. +The name field of an artifact. When specified, only artifacts with this name will be returned. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository). diff --git a/docs/actions/listEnvironmentSecrets.md b/docs/actions/listEnvironmentSecrets.md index a8cfc387d..20506c47c 100644 --- a/docs/actions/listEnvironmentSecrets.md +++ b/docs/actions/listEnvironmentSecrets.md @@ -8,7 +8,12 @@ type: API method # List environment secrets -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.listEnvironmentSecrets({ @@ -51,4 +56,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-environment-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#list-environment-secrets). diff --git a/docs/actions/listEnvironmentVariables.md b/docs/actions/listEnvironmentVariables.md index 29701d24e..3e1536db8 100644 --- a/docs/actions/listEnvironmentVariables.md +++ b/docs/actions/listEnvironmentVariables.md @@ -8,7 +8,12 @@ type: API method # List environment variables -Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint. +Lists all environment variables. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `environments:read` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.listEnvironmentVariables({ diff --git a/docs/actions/listJobsForWorkflowRun.md b/docs/actions/listJobsForWorkflowRun.md index 98b586c54..0df853572 100644 --- a/docs/actions/listJobsForWorkflowRun.md +++ b/docs/actions/listJobsForWorkflowRun.md @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run). diff --git a/docs/actions/listJobsForWorkflowRunAttempt.md b/docs/actions/listJobsForWorkflowRunAttempt.md index e91296059..d111bc9da 100644 --- a/docs/actions/listJobsForWorkflowRunAttempt.md +++ b/docs/actions/listJobsForWorkflowRunAttempt.md @@ -63,4 +63,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt). diff --git a/docs/actions/listLabelsForSelfHostedRunnerForOrg.md b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md index a22fc274c..d0b5b0f56 100644 --- a/docs/actions/listLabelsForSelfHostedRunnerForOrg.md +++ b/docs/actions/listLabelsForSelfHostedRunnerForOrg.md @@ -11,6 +11,9 @@ type: API method Lists all labels for a self-hosted runner configured in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listLabelsForSelfHostedRunnerForOrg({ @@ -43,4 +46,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md index 60b6e95af..27ad3b69b 100644 --- a/docs/actions/listLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/listLabelsForSelfHostedRunnerForRepo.md @@ -10,8 +10,10 @@ type: API method Lists all labels for a self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listLabelsForSelfHostedRunnerForRepo({ @@ -50,4 +52,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/listOrgSecrets.md b/docs/actions/listOrgSecrets.md index 1597d61c3..e872ce756 100644 --- a/docs/actions/listOrgSecrets.md +++ b/docs/actions/listOrgSecrets.md @@ -8,7 +8,13 @@ type: API method # List organization secrets -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. +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. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.listOrgSecrets({ @@ -45,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-organization-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#list-organization-secrets). diff --git a/docs/actions/listOrgVariables.md b/docs/actions/listOrgVariables.md index f4408a713..5be79fa84 100644 --- a/docs/actions/listOrgVariables.md +++ b/docs/actions/listOrgVariables.md @@ -8,7 +8,8 @@ type: API method # List organization variables -Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. +Lists all organization variables. +You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.listOrgVariables({ diff --git a/docs/actions/listRepoOrganizationSecrets.md b/docs/actions/listRepoOrganizationSecrets.md index a49190665..001038d5a 100644 --- a/docs/actions/listRepoOrganizationSecrets.md +++ b/docs/actions/listRepoOrganizationSecrets.md @@ -8,7 +8,12 @@ type: API method # List repository organization secrets -Lists all organization secrets shared with 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. +Lists all organization secrets shared with 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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.listRepoOrganizationSecrets({ diff --git a/docs/actions/listRepoOrganizationVariables.md b/docs/actions/listRepoOrganizationVariables.md index 0e673a61b..1a1f61230 100644 --- a/docs/actions/listRepoOrganizationVariables.md +++ b/docs/actions/listRepoOrganizationVariables.md @@ -8,7 +8,12 @@ type: API method # List repository organization variables -Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Lists all organiation variables shared with a repository. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.listRepoOrganizationVariables({ diff --git a/docs/actions/listRepoRequiredWorkflows.md b/docs/actions/listRepoRequiredWorkflows.md deleted file mode 100644 index 3657a3b1e..000000000 --- a/docs/actions/listRepoRequiredWorkflows.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: List repository required workflows -example: octokit.rest.actions.listRepoRequiredWorkflows({ org, repo }) -route: GET /repos/{org}/{repo}/actions/required_workflows -scope: actions -type: API method ---- - -# List repository required workflows - -Lists the required 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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.listRepoRequiredWorkflows({ - org, - repo, -}); -``` - -## Parameters - - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
per_pageno - -The number of results per page (max 100). - -
pageno - -Page number of the results to fetch. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-repository-required-workflows). diff --git a/docs/actions/listRepoSecrets.md b/docs/actions/listRepoSecrets.md index c595881aa..a96289aad 100644 --- a/docs/actions/listRepoSecrets.md +++ b/docs/actions/listRepoSecrets.md @@ -8,7 +8,12 @@ type: API method # List repository secrets -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. +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. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.listRepoSecrets({ @@ -51,4 +56,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-repository-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#list-repository-secrets). diff --git a/docs/actions/listRepoVariables.md b/docs/actions/listRepoVariables.md index d04652213..e5b9691f0 100644 --- a/docs/actions/listRepoVariables.md +++ b/docs/actions/listRepoVariables.md @@ -8,7 +8,11 @@ type: API method # List repository variables -Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Lists all repository variables. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.listRepoVariables({ diff --git a/docs/actions/listRepoWorkflows.md b/docs/actions/listRepoWorkflows.md index d75a52009..19e5dbf7a 100644 --- a/docs/actions/listRepoWorkflows.md +++ b/docs/actions/listRepoWorkflows.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-repository-workflows). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflows#list-repository-workflows). diff --git a/docs/actions/listRequiredWorkflowRuns.md b/docs/actions/listRequiredWorkflowRuns.md deleted file mode 100644 index f75853aa1..000000000 --- a/docs/actions/listRequiredWorkflowRuns.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -name: List workflow runs for a required workflow -example: octokit.rest.actions.listRequiredWorkflowRuns({ owner, repo, required_workflow_id_for_repo }) -route: GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs -scope: actions -type: API method ---- - -# List workflow runs for a required workflow - -List all workflow runs for a required workflow. 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). - -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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.listRequiredWorkflowRuns({ - owner, - repo, - required_workflow_id_for_repo, -}); -``` - -## Parameters - - - - - - - - - - - - - - - - - - - - - - - - -
namerequireddescription
owneryes - -The account owner of the repository. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
required_workflow_id_for_repoyes - -The ID of the required workflow that has run at least once in a repository. - -
actorno - -Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. - -
branchno - -Returns workflow runs associated with a branch. Use the name of the branch of the `push`. - -
eventno - -Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." - -
statusno - -Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. - -
per_pageno - -The number of results per page (max 100). - -
pageno - -Page number of the results to fetch. - -
createdno - -Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - -
exclude_pull_requestsno - -If `true` pull requests are omitted from the response (empty array). - -
check_suite_idno - -Returns workflow runs with the `check_suite_id` that you specify. - -
head_shano - -Only returns workflow runs that are associated with the specified `head_sha`. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-required-workflow-runs). diff --git a/docs/actions/listRequiredWorkflows.md b/docs/actions/listRequiredWorkflows.md deleted file mode 100644 index 6f7031392..000000000 --- a/docs/actions/listRequiredWorkflows.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: List required workflows -example: octokit.rest.actions.listRequiredWorkflows({ org }) -route: GET /orgs/{org}/actions/required_workflows -scope: actions -type: API method ---- - -# List required workflows - -List all required workflows in an organization. - -You must authenticate using an access token with the `read:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.listRequiredWorkflows({ - org, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
per_pageno - -The number of results per page (max 100). - -
pageno - -Page number of the results to fetch. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-required-workflows). diff --git a/docs/actions/listRunnerApplicationsForOrg.md b/docs/actions/listRunnerApplicationsForOrg.md index 3a2f9f8bf..919fad6df 100644 --- a/docs/actions/listRunnerApplicationsForOrg.md +++ b/docs/actions/listRunnerApplicationsForOrg.md @@ -11,6 +11,9 @@ type: API method Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listRunnerApplicationsForOrg({ @@ -37,4 +40,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization). diff --git a/docs/actions/listRunnerApplicationsForRepo.md b/docs/actions/listRunnerApplicationsForRepo.md index 78f6f52d4..ef5f95bd7 100644 --- a/docs/actions/listRunnerApplicationsForRepo.md +++ b/docs/actions/listRunnerApplicationsForRepo.md @@ -11,6 +11,9 @@ type: API method Lists binaries for the runner application that you can download and run. You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listRunnerApplicationsForRepo({ @@ -43,4 +46,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository). diff --git a/docs/actions/listSelectedReposForOrgSecret.md b/docs/actions/listSelectedReposForOrgSecret.md index 1e5792d89..86fb5e587 100644 --- a/docs/actions/listSelectedReposForOrgSecret.md +++ b/docs/actions/listSelectedReposForOrgSecret.md @@ -8,7 +8,13 @@ type: API method # List selected repositories for an organization secret -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. +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. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.listSelectedReposForOrgSecret({ @@ -51,4 +57,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret). diff --git a/docs/actions/listSelectedReposForOrgVariable.md b/docs/actions/listSelectedReposForOrgVariable.md index a939dcb07..763d7e035 100644 --- a/docs/actions/listSelectedReposForOrgVariable.md +++ b/docs/actions/listSelectedReposForOrgVariable.md @@ -8,7 +8,13 @@ type: API method # List selected repositories for an organization variable -Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. +Lists all repositories that can access an organization variable +that is available to selected repositories. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.listSelectedReposForOrgVariable({ diff --git a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md index bbc02d2ba..8901dcaea 100644 --- a/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/listSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -47,4 +47,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization). diff --git a/docs/actions/listSelectedRepositoriesRequiredWorkflow.md b/docs/actions/listSelectedRepositoriesRequiredWorkflow.md deleted file mode 100644 index 4c936e1aa..000000000 --- a/docs/actions/listSelectedRepositoriesRequiredWorkflow.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -name: List selected repositories for a required workflow -example: octokit.rest.actions.listSelectedRepositoriesRequiredWorkflow({ org, required_workflow_id }) -route: GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories -scope: actions -type: API method ---- - -# List selected repositories for a required workflow - -Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories. - -You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.listSelectedRepositoriesRequiredWorkflow({ - org, - required_workflow_id, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-selected-repositories-required-workflows). diff --git a/docs/actions/listSelfHostedRunnersForOrg.md b/docs/actions/listSelfHostedRunnersForOrg.md index 419a22bae..682f89436 100644 --- a/docs/actions/listSelfHostedRunnersForOrg.md +++ b/docs/actions/listSelfHostedRunnersForOrg.md @@ -11,6 +11,9 @@ type: API method Lists all self-hosted runners configured in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listSelfHostedRunnersForOrg({ @@ -29,7 +32,12 @@ octokit.rest.actions.listSelfHostedRunnersForOrg({ - orgyes + nameno + +The name of a self-hosted runner. + + +orgyes The organization name. The name is not case sensitive. @@ -47,4 +55,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization). diff --git a/docs/actions/listSelfHostedRunnersForRepo.md b/docs/actions/listSelfHostedRunnersForRepo.md index 977c672a0..4999d0daa 100644 --- a/docs/actions/listSelfHostedRunnersForRepo.md +++ b/docs/actions/listSelfHostedRunnersForRepo.md @@ -8,7 +8,12 @@ type: API method # List self-hosted runners for a repository -Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. +Lists all self-hosted runners configured in a repository. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.listSelfHostedRunnersForRepo({ @@ -28,7 +33,12 @@ octokit.rest.actions.listSelfHostedRunnersForRepo({ - owneryes + nameno + +The name of a self-hosted runner. + + +owneryes The account owner of the repository. The name is not case sensitive. @@ -51,4 +61,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository). diff --git a/docs/actions/listWorkflowRunArtifacts.md b/docs/actions/listWorkflowRunArtifacts.md index b48ee627a..95d0e83ca 100644 --- a/docs/actions/listWorkflowRunArtifacts.md +++ b/docs/actions/listWorkflowRunArtifacts.md @@ -53,8 +53,13 @@ The number of results per page (max 100). Page number of the results to fetch. + +nameno + +The name field of an artifact. When specified, only artifacts with this name will be returned. + -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts). diff --git a/docs/actions/listWorkflowRuns.md b/docs/actions/listWorkflowRuns.md index 59b5e052c..61cd64bee 100644 --- a/docs/actions/listWorkflowRuns.md +++ b/docs/actions/listWorkflowRuns.md @@ -99,4 +99,4 @@ Only returns workflow runs that are associated with the specified `head_sha`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-workflow-runs). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow). diff --git a/docs/actions/listWorkflowRunsForRepo.md b/docs/actions/listWorkflowRunsForRepo.md index fc0e66310..c5e6a8c75 100644 --- a/docs/actions/listWorkflowRunsForRepo.md +++ b/docs/actions/listWorkflowRunsForRepo.md @@ -93,4 +93,4 @@ Only returns workflow runs that are associated with the specified `head_sha`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository). diff --git a/docs/actions/reRunJobForWorkflowRun.md b/docs/actions/reRunJobForWorkflowRun.md index 0714da56b..fe4407ce7 100644 --- a/docs/actions/reRunJobForWorkflowRun.md +++ b/docs/actions/reRunJobForWorkflowRun.md @@ -8,7 +8,11 @@ type: API method # Re-run a job from a workflow run -Re-run a job and its dependent jobs in 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. +Re-run a job and its dependent jobs in a workflow run. + +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `actions:write` permission to use this endpoint. ```js octokit.rest.actions.reRunJobForWorkflowRun({ @@ -52,4 +56,4 @@ Whether to enable debug logging for the re-run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run). diff --git a/docs/actions/reRunWorkflow.md b/docs/actions/reRunWorkflow.md index cd609fa0e..dd942236c 100644 --- a/docs/actions/reRunWorkflow.md +++ b/docs/actions/reRunWorkflow.md @@ -52,4 +52,4 @@ Whether to enable debug logging for the re-run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-a-workflow). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow). diff --git a/docs/actions/reRunWorkflowFailedJobs.md b/docs/actions/reRunWorkflowFailedJobs.md index 5e0b7c661..c1edd2d51 100644 --- a/docs/actions/reRunWorkflowFailedJobs.md +++ b/docs/actions/reRunWorkflowFailedJobs.md @@ -52,4 +52,4 @@ Whether to enable debug logging for the re-run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run). diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md index 9c30aca40..59a15a7d0 100644 --- a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForOrg.md @@ -12,6 +12,9 @@ Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForOrg({ @@ -44,4 +47,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md index 6e79820d5..bffc4245d 100644 --- a/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeAllCustomLabelsFromSelfHostedRunnerForRepo.md @@ -11,8 +11,10 @@ type: API method Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.removeAllCustomLabelsFromSelfHostedRunnerForRepo({ @@ -51,4 +53,4 @@ Unique identifier of the self-hosted runner. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md index 96232f495..6371d910c 100644 --- a/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForOrg.md @@ -15,6 +15,9 @@ This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForOrg({ @@ -53,4 +56,4 @@ The name of a self-hosted runner's custom label. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md index 0dd8c8ad1..0b41ba67e 100644 --- a/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md +++ b/docs/actions/removeCustomLabelFromSelfHostedRunnerForRepo.md @@ -14,8 +14,10 @@ in a repository. Returns the remaining labels from the runner. This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.removeCustomLabelFromSelfHostedRunnerForRepo({ @@ -60,4 +62,4 @@ The name of a self-hosted runner's custom label. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/removeSelectedRepoFromOrgSecret.md b/docs/actions/removeSelectedRepoFromOrgSecret.md index 03d423d65..146ffe89e 100644 --- a/docs/actions/removeSelectedRepoFromOrgSecret.md +++ b/docs/actions/removeSelectedRepoFromOrgSecret.md @@ -8,7 +8,14 @@ type: API method # Remove selected repository from an organization secret -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. +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/actions/secrets#create-or-update-an-organization-secret). + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.removeSelectedRepoFromOrgSecret({ @@ -45,4 +52,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret). diff --git a/docs/actions/removeSelectedRepoFromOrgVariable.md b/docs/actions/removeSelectedRepoFromOrgVariable.md index 1c710e220..3d00bfcb4 100644 --- a/docs/actions/removeSelectedRepoFromOrgVariable.md +++ b/docs/actions/removeSelectedRepoFromOrgVariable.md @@ -8,7 +8,14 @@ type: API method # Remove selected repository from an organization variable -Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Removes a repository from an organization variable that is +available to selected repositories. Organization variables that are available to +selected repositories have their `visibility` field set to `selected`. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.removeSelectedRepoFromOrgVariable({ diff --git a/docs/actions/removeSelectedRepoFromRequiredWorkflow.md b/docs/actions/removeSelectedRepoFromRequiredWorkflow.md deleted file mode 100644 index 65d4d50e5..000000000 --- a/docs/actions/removeSelectedRepoFromRequiredWorkflow.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Remove a selected repository from required workflow -example: octokit.rest.actions.removeSelectedRepoFromRequiredWorkflow({ org, required_workflow_id, repository_id }) -route: DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id} -scope: actions -type: API method ---- - -# Remove a selected repository from required workflow - -Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.removeSelectedRepoFromRequiredWorkflow({ - org, - required_workflow_id, - repository_id, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
repository_idyes - -The unique identifier of the repository. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#remove-a-repository-from-selected-repositories-list-for-a-required-workflow). diff --git a/docs/actions/reviewCustomGatesForRun.md b/docs/actions/reviewCustomGatesForRun.md index 5d1212524..ce47c253a 100644 --- a/docs/actions/reviewCustomGatesForRun.md +++ b/docs/actions/reviewCustomGatesForRun.md @@ -13,6 +13,7 @@ Approve or reject custom deployment protection rules provided by a GitHub App fo **Note:** GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have read and write permission for **Deployments** to use this endpoint. ```js diff --git a/docs/actions/reviewPendingDeploymentsForRun.md b/docs/actions/reviewPendingDeploymentsForRun.md index d7faee01b..fc80d301a 100644 --- a/docs/actions/reviewPendingDeploymentsForRun.md +++ b/docs/actions/reviewPendingDeploymentsForRun.md @@ -67,4 +67,4 @@ A comment to accompany the deployment review -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). diff --git a/docs/actions/setAllowedActionsOrganization.md b/docs/actions/setAllowedActionsOrganization.md index 09a24e016..dec99c87d 100644 --- a/docs/actions/setAllowedActionsOrganization.md +++ b/docs/actions/setAllowedActionsOrganization.md @@ -54,4 +54,4 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization). diff --git a/docs/actions/setAllowedActionsRepository.md b/docs/actions/setAllowedActionsRepository.md index 20e46755b..58a26f63c 100644 --- a/docs/actions/setAllowedActionsRepository.md +++ b/docs/actions/setAllowedActionsRepository.md @@ -60,4 +60,4 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository). diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md index 8b14d6a3a..9f5a903ec 100644 --- a/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForOrg.md @@ -12,6 +12,9 @@ Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForOrg({ @@ -50,4 +53,4 @@ The names of the custom labels to set for the runner. You can pass an empty arra -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization). diff --git a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md index 906f9770f..4f313c686 100644 --- a/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md +++ b/docs/actions/setCustomLabelsForSelfHostedRunnerForRepo.md @@ -11,8 +11,10 @@ type: API method Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. -You must authenticate using an access token with the `repo` scope to use this -endpoint. +You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. +Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. ```js octokit.rest.actions.setCustomLabelsForSelfHostedRunnerForRepo({ @@ -57,4 +59,4 @@ The names of the custom labels to set for the runner. You can pass an empty arra -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository). diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md index 46841676f..dd6d783d9 100644 --- a/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsOrganization.md @@ -49,4 +49,4 @@ Whether GitHub Actions can approve pull requests. Enabling this can be a securit -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-default-workflow-permissions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization). diff --git a/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md index c9b48f37d..6424d4164 100644 --- a/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md +++ b/docs/actions/setGithubActionsDefaultWorkflowPermissionsRepository.md @@ -55,4 +55,4 @@ Whether GitHub Actions can approve pull requests. Enabling this can be a securit -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository). diff --git a/docs/actions/setGithubActionsPermissionsOrganization.md b/docs/actions/setGithubActionsPermissionsOrganization.md index a8fb3b1d8..ccd42aec0 100644 --- a/docs/actions/setGithubActionsPermissionsOrganization.md +++ b/docs/actions/setGithubActionsPermissionsOrganization.md @@ -48,4 +48,4 @@ The permissions policy that controls the actions and reusable workflows that are -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization). diff --git a/docs/actions/setGithubActionsPermissionsRepository.md b/docs/actions/setGithubActionsPermissionsRepository.md index 78c002f62..05f3bdb99 100644 --- a/docs/actions/setGithubActionsPermissionsRepository.md +++ b/docs/actions/setGithubActionsPermissionsRepository.md @@ -54,4 +54,4 @@ The permissions policy that controls the actions and reusable workflows that are -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository). diff --git a/docs/actions/setSelectedReposForOrgSecret.md b/docs/actions/setSelectedReposForOrgSecret.md index cac670ed2..54037a3ad 100644 --- a/docs/actions/setSelectedReposForOrgSecret.md +++ b/docs/actions/setSelectedReposForOrgSecret.md @@ -8,7 +8,14 @@ type: API method # Set selected repositories for an organization secret -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. +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/actions/secrets#create-or-update-an-organization-secret). + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `secrets` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read secrets. ```js octokit.rest.actions.setSelectedReposForOrgSecret({ @@ -41,10 +48,10 @@ The name of the secret. 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 [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-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. +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 [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret). diff --git a/docs/actions/setSelectedReposForOrgVariable.md b/docs/actions/setSelectedReposForOrgVariable.md index cbd4da1c4..019a24f48 100644 --- a/docs/actions/setSelectedReposForOrgVariable.md +++ b/docs/actions/setSelectedReposForOrgVariable.md @@ -8,7 +8,15 @@ type: API method # Set selected repositories for an organization variable -Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Replaces all repositories for an organization variable that is available +to selected repositories. Organization variables that are available to selected +repositories have their `visibility` field set to `selected`. + +You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. +GitHub Apps must have the `organization_actions_variables:write` organization permission to use this +endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.setSelectedReposForOrgVariable({ diff --git a/docs/actions/setSelectedReposToRequiredWorkflow.md b/docs/actions/setSelectedReposToRequiredWorkflow.md deleted file mode 100644 index 5fcd05f49..000000000 --- a/docs/actions/setSelectedReposToRequiredWorkflow.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Sets repositories for a required workflow -example: octokit.rest.actions.setSelectedReposToRequiredWorkflow({ org, required_workflow_id, selected_repository_ids }) -route: PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories -scope: actions -type: API method ---- - -# Sets repositories for a required workflow - -Sets the repositories for a required workflow that is required for selected repositories. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.setSelectedReposToRequiredWorkflow({ - org, - required_workflow_id, - selected_repository_ids, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
selected_repository_idsyes - -The IDs of the repositories for which the workflow should be required. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-a-required-workflow). diff --git a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md index d28f294cf..d1958189f 100644 --- a/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md +++ b/docs/actions/setSelectedRepositoriesEnabledGithubActionsOrganization.md @@ -43,4 +43,4 @@ List of repository IDs to enable for GitHub Actions. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization). diff --git a/docs/actions/setWorkflowAccessToRepository.md b/docs/actions/setWorkflowAccessToRepository.md index cd05ed340..e237b5125 100644 --- a/docs/actions/setWorkflowAccessToRepository.md +++ b/docs/actions/setWorkflowAccessToRepository.md @@ -55,4 +55,4 @@ repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository). diff --git a/docs/actions/updateEnvironmentVariable.md b/docs/actions/updateEnvironmentVariable.md index a554811ea..84e0e55ea 100644 --- a/docs/actions/updateEnvironmentVariable.md +++ b/docs/actions/updateEnvironmentVariable.md @@ -9,8 +9,11 @@ type: API method # Update an environment variable Updates an environment variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `environment:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.updateEnvironmentVariable({ diff --git a/docs/actions/updateOrgVariable.md b/docs/actions/updateOrgVariable.md index 1b13d5227..856dc83ee 100644 --- a/docs/actions/updateOrgVariable.md +++ b/docs/actions/updateOrgVariable.md @@ -9,8 +9,11 @@ type: API method # Update an organization variable Updates an organization variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `admin:org` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.updateOrgVariable({ diff --git a/docs/actions/updateRepoVariable.md b/docs/actions/updateRepoVariable.md index cb6a911fc..49a0b4211 100644 --- a/docs/actions/updateRepoVariable.md +++ b/docs/actions/updateRepoVariable.md @@ -9,8 +9,11 @@ type: API method # Update a repository variable Updates a repository variable that you can reference in a GitHub Actions workflow. + You must authenticate using an access token with the `repo` scope to use this endpoint. +If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. +Authenticated users must have collaborator access to a repository to create, update, or read variables. ```js octokit.rest.actions.updateRepoVariable({ diff --git a/docs/actions/updateRequiredWorkflow.md b/docs/actions/updateRequiredWorkflow.md deleted file mode 100644 index 675c7554d..000000000 --- a/docs/actions/updateRequiredWorkflow.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -name: Update a required workflow -example: octokit.rest.actions.updateRequiredWorkflow({ org, required_workflow_id }) -route: PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id} -scope: actions -type: API method ---- - -# Update a required workflow - -Update a required workflow in an organization. - -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - -```js -octokit.rest.actions.updateRequiredWorkflow({ - org, - required_workflow_id, -}); -``` - -## Parameters - - - - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
required_workflow_idyes - -The unique identifier of the required workflow. - -
workflow_file_pathno - -Path of the workflow file to be configured as a required workflow. - -
repository_idno - -The ID of the repository that contains the workflow file. - -
scopeno - -Enable the required workflow for all repositories or selected repositories in the organization. - -
selected_repository_idsno - -A list of repository IDs where you want to enable the required workflow. A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#update-a-required-workflow). diff --git a/docs/activity/checkRepoIsStarredByAuthenticatedUser.md b/docs/activity/checkRepoIsStarredByAuthenticatedUser.md index 78e03c66e..e831d7236 100644 --- a/docs/activity/checkRepoIsStarredByAuthenticatedUser.md +++ b/docs/activity/checkRepoIsStarredByAuthenticatedUser.md @@ -8,6 +8,8 @@ type: API method # Check if a repository is starred by the authenticated user +Whether the authenticated user has starred the repository. + ```js octokit.rest.activity.checkRepoIsStarredByAuthenticatedUser({ owner, @@ -39,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user). diff --git a/docs/activity/deleteRepoSubscription.md b/docs/activity/deleteRepoSubscription.md index f5e7b1d43..0cc84d45d 100644 --- a/docs/activity/deleteRepoSubscription.md +++ b/docs/activity/deleteRepoSubscription.md @@ -8,7 +8,7 @@ type: API method # Delete a repository subscription -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). +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/activity/watching#set-a-repository-subscription). ```js octokit.rest.activity.deleteRepoSubscription({ @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#delete-a-repository-subscription). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription). diff --git a/docs/activity/deleteThreadSubscription.md b/docs/activity/deleteThreadSubscription.md index fec1e9457..1140fc909 100644 --- a/docs/activity/deleteThreadSubscription.md +++ b/docs/activity/deleteThreadSubscription.md @@ -8,7 +8,7 @@ type: API method # Delete a thread subscription -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`. +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/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. ```js octokit.rest.activity.deleteThreadSubscription({ @@ -29,10 +29,10 @@ octokit.rest.activity.deleteThreadSubscription({ thread_idyes -The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#delete-a-thread-subscription). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription). diff --git a/docs/activity/getFeeds.md b/docs/activity/getFeeds.md index 898e200c4..21a504666 100644 --- a/docs/activity/getFeeds.md +++ b/docs/activity/getFeeds.md @@ -28,4 +28,4 @@ octokit.rest.activity.getFeeds(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#get-feeds). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/feeds#get-feeds). diff --git a/docs/activity/getRepoSubscription.md b/docs/activity/getRepoSubscription.md index 9c1baef94..a7a4b104d 100644 --- a/docs/activity/getRepoSubscription.md +++ b/docs/activity/getRepoSubscription.md @@ -8,6 +8,8 @@ type: API method # Get a repository subscription +Gets information about whether the authenticated user is subscribed to the repository. + ```js octokit.rest.activity.getRepoSubscription({ owner, @@ -39,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#get-a-repository-subscription). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). diff --git a/docs/activity/getThread.md b/docs/activity/getThread.md index aa7358fc8..2487576a0 100644 --- a/docs/activity/getThread.md +++ b/docs/activity/getThread.md @@ -29,10 +29,10 @@ octokit.rest.activity.getThread({ thread_idyes -The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#get-a-thread). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#get-a-thread). diff --git a/docs/activity/getThreadSubscriptionForAuthenticatedUser.md b/docs/activity/getThreadSubscriptionForAuthenticatedUser.md index 13f6541b9..b5bacb737 100644 --- a/docs/activity/getThreadSubscriptionForAuthenticatedUser.md +++ b/docs/activity/getThreadSubscriptionForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # Get a thread subscription for the authenticated user -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). +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/activity/watching#get-a-repository-subscription). Note 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. @@ -31,10 +31,10 @@ octokit.rest.activity.getThreadSubscriptionForAuthenticatedUser({ thread_idyes -The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user). diff --git a/docs/activity/listEventsForAuthenticatedUser.md b/docs/activity/listEventsForAuthenticatedUser.md index e2f4412e1..8bd9872a8 100644 --- a/docs/activity/listEventsForAuthenticatedUser.md +++ b/docs/activity/listEventsForAuthenticatedUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-events-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user). diff --git a/docs/activity/listNotificationsForAuthenticatedUser.md b/docs/activity/listNotificationsForAuthenticatedUser.md index b06c17dea..7f455b018 100644 --- a/docs/activity/listNotificationsForAuthenticatedUser.md +++ b/docs/activity/listNotificationsForAuthenticatedUser.md @@ -37,7 +37,7 @@ If `true`, only shows notifications in which the user is directly participating sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. beforeno @@ -58,4 +58,4 @@ The number of results per page (max 50). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user). diff --git a/docs/activity/listOrgEventsForAuthenticatedUser.md b/docs/activity/listOrgEventsForAuthenticatedUser.md index 92cecdb03..395fe4df4 100644 --- a/docs/activity/listOrgEventsForAuthenticatedUser.md +++ b/docs/activity/listOrgEventsForAuthenticatedUser.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-organization-events-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user). diff --git a/docs/activity/listPublicEvents.md b/docs/activity/listPublicEvents.md index e538fb21e..c6f45592d 100644 --- a/docs/activity/listPublicEvents.md +++ b/docs/activity/listPublicEvents.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-public-events). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-public-events). diff --git a/docs/activity/listPublicEventsForRepoNetwork.md b/docs/activity/listPublicEventsForRepoNetwork.md index 773deb3b2..707c518b7 100644 --- a/docs/activity/listPublicEventsForRepoNetwork.md +++ b/docs/activity/listPublicEventsForRepoNetwork.md @@ -49,4 +49,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories). diff --git a/docs/activity/listPublicEventsForUser.md b/docs/activity/listPublicEventsForUser.md index 6804c84ed..f72fecfd1 100644 --- a/docs/activity/listPublicEventsForUser.md +++ b/docs/activity/listPublicEventsForUser.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-public-events-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-public-events-for-a-user). diff --git a/docs/activity/listPublicOrgEvents.md b/docs/activity/listPublicOrgEvents.md index 7935dc63a..4c4ead57d 100644 --- a/docs/activity/listPublicOrgEvents.md +++ b/docs/activity/listPublicOrgEvents.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-public-organization-events). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-public-organization-events). diff --git a/docs/activity/listReceivedEventsForUser.md b/docs/activity/listReceivedEventsForUser.md index ab2e147f5..6dcc67243 100644 --- a/docs/activity/listReceivedEventsForUser.md +++ b/docs/activity/listReceivedEventsForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-events-received-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user). diff --git a/docs/activity/listReceivedPublicEventsForUser.md b/docs/activity/listReceivedPublicEventsForUser.md index e317ecae6..ee944b055 100644 --- a/docs/activity/listReceivedPublicEventsForUser.md +++ b/docs/activity/listReceivedPublicEventsForUser.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user). diff --git a/docs/activity/listRepoEvents.md b/docs/activity/listRepoEvents.md index 6e76b44c8..99f5bebda 100644 --- a/docs/activity/listRepoEvents.md +++ b/docs/activity/listRepoEvents.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repository-events). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/events#list-repository-events). diff --git a/docs/activity/listRepoNotificationsForAuthenticatedUser.md b/docs/activity/listRepoNotificationsForAuthenticatedUser.md index 8d837b295..1a10bda28 100644 --- a/docs/activity/listRepoNotificationsForAuthenticatedUser.md +++ b/docs/activity/listRepoNotificationsForAuthenticatedUser.md @@ -50,7 +50,7 @@ If `true`, only shows notifications in which the user is directly participating sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. beforeno @@ -71,4 +71,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user). diff --git a/docs/activity/listReposStarredByAuthenticatedUser.md b/docs/activity/listReposStarredByAuthenticatedUser.md index b32e5fd89..a5170ff95 100644 --- a/docs/activity/listReposStarredByAuthenticatedUser.md +++ b/docs/activity/listReposStarredByAuthenticatedUser.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user). diff --git a/docs/activity/listReposStarredByUser.md b/docs/activity/listReposStarredByUser.md index 14e5b4e9b..e2d0df326 100644 --- a/docs/activity/listReposStarredByUser.md +++ b/docs/activity/listReposStarredByUser.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user). diff --git a/docs/activity/listReposWatchedByUser.md b/docs/activity/listReposWatchedByUser.md index 4857b105a..daf0dff7c 100644 --- a/docs/activity/listReposWatchedByUser.md +++ b/docs/activity/listReposWatchedByUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repositories-watched-by-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user). diff --git a/docs/activity/listStargazersForRepo.md b/docs/activity/listStargazersForRepo.md index 2d32a468f..308d5184d 100644 --- a/docs/activity/listStargazersForRepo.md +++ b/docs/activity/listStargazersForRepo.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-stargazers). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#list-stargazers). diff --git a/docs/activity/listWatchedReposForAuthenticatedUser.md b/docs/activity/listWatchedReposForAuthenticatedUser.md index 17d55c39a..0d6b9d59c 100644 --- a/docs/activity/listWatchedReposForAuthenticatedUser.md +++ b/docs/activity/listWatchedReposForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-repositories-watched-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user). diff --git a/docs/activity/listWatchersForRepo.md b/docs/activity/listWatchersForRepo.md index cadeca173..3c278d487 100644 --- a/docs/activity/listWatchersForRepo.md +++ b/docs/activity/listWatchersForRepo.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#list-watchers). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#list-watchers). diff --git a/docs/activity/markNotificationsAsRead.md b/docs/activity/markNotificationsAsRead.md index e12cbc801..2c83491a0 100644 --- a/docs/activity/markNotificationsAsRead.md +++ b/docs/activity/markNotificationsAsRead.md @@ -8,7 +8,7 @@ type: API method # Mark notifications as read -Marks all notifications as "read" for the current user. 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`. +Marks all notifications as "read" for the current user. 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/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. ```js octokit.rest.activity.markNotificationsAsRead(); @@ -38,4 +38,4 @@ Whether the notification has been read. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#mark-notifications-as-read). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#mark-notifications-as-read). diff --git a/docs/activity/markRepoNotificationsAsRead.md b/docs/activity/markRepoNotificationsAsRead.md index 17064fd55..95d164ce9 100644 --- a/docs/activity/markRepoNotificationsAsRead.md +++ b/docs/activity/markRepoNotificationsAsRead.md @@ -8,7 +8,7 @@ type: API method # Mark repository notifications as read -Marks all notifications in a repository as "read" for the current user. 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`. +Marks all notifications in a repository as "read" for the current user. 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/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. ```js octokit.rest.activity.markRepoNotificationsAsRead({ @@ -46,4 +46,4 @@ Describes the last point that notifications were checked. Anything updated since -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read). diff --git a/docs/activity/markThreadAsRead.md b/docs/activity/markThreadAsRead.md index 32fc6651c..1c3438374 100644 --- a/docs/activity/markThreadAsRead.md +++ b/docs/activity/markThreadAsRead.md @@ -29,10 +29,10 @@ octokit.rest.activity.markThreadAsRead({ thread_idyes -The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#mark-a-thread-as-read). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read). diff --git a/docs/activity/setRepoSubscription.md b/docs/activity/setRepoSubscription.md index 013be50d7..4d4a48c4a 100644 --- a/docs/activity/setRepoSubscription.md +++ b/docs/activity/setRepoSubscription.md @@ -8,7 +8,7 @@ type: API method # Set a repository subscription -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. +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/activity/watching#delete-a-repository-subscription) completely. ```js octokit.rest.activity.setRepoSubscription({ @@ -51,4 +51,4 @@ Determines if all notifications should be blocked from this repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#set-a-repository-subscription). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). diff --git a/docs/activity/setThreadSubscription.md b/docs/activity/setThreadSubscription.md index 694a72f0a..ade63cec0 100644 --- a/docs/activity/setThreadSubscription.md +++ b/docs/activity/setThreadSubscription.md @@ -12,7 +12,7 @@ If you are watching a repository, you receive notifications for all threads by d You 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. -Unsubscribing 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. +Unsubscribing 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/activity/notifications#delete-a-thread-subscription) endpoint. ```js octokit.rest.activity.setThreadSubscription({ @@ -33,7 +33,7 @@ octokit.rest.activity.setThreadSubscription({ thread_idyes -The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)). +The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). ignoredno @@ -44,4 +44,4 @@ Whether to block all notifications from a thread. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#set-a-thread-subscription). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription). diff --git a/docs/activity/starRepoForAuthenticatedUser.md b/docs/activity/starRepoForAuthenticatedUser.md index c066c3146..040679460 100644 --- a/docs/activity/starRepoForAuthenticatedUser.md +++ b/docs/activity/starRepoForAuthenticatedUser.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#star-a-repository-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user). diff --git a/docs/activity/unstarRepoForAuthenticatedUser.md b/docs/activity/unstarRepoForAuthenticatedUser.md index 39f057099..fbf92f5f1 100644 --- a/docs/activity/unstarRepoForAuthenticatedUser.md +++ b/docs/activity/unstarRepoForAuthenticatedUser.md @@ -8,6 +8,8 @@ type: API method # Unstar a repository for the authenticated user +Unstar a repository that the authenticated user has previously starred. + ```js octokit.rest.activity.unstarRepoForAuthenticatedUser({ owner, @@ -39,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user). diff --git a/docs/apps/addRepoToInstallation.md b/docs/apps/addRepoToInstallation.md index 29292fdab..acd793473 100644 --- a/docs/apps/addRepoToInstallation.md +++ b/docs/apps/addRepoToInstallation.md @@ -45,4 +45,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation). diff --git a/docs/apps/addRepoToInstallationForAuthenticatedUser.md b/docs/apps/addRepoToInstallationForAuthenticatedUser.md index a81399591..55e21989d 100644 --- a/docs/apps/addRepoToInstallationForAuthenticatedUser.md +++ b/docs/apps/addRepoToInstallationForAuthenticatedUser.md @@ -43,4 +43,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation). diff --git a/docs/apps/checkToken.md b/docs/apps/checkToken.md index 309a2e247..383230b8a 100644 --- a/docs/apps/checkToken.md +++ b/docs/apps/checkToken.md @@ -41,4 +41,4 @@ The access_token of the OAuth or GitHub application. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#check-a-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/oauth-applications#check-a-token). diff --git a/docs/apps/createFromManifest.md b/docs/apps/createFromManifest.md index cfda651a2..1fb7f92be 100644 --- a/docs/apps/createFromManifest.md +++ b/docs/apps/createFromManifest.md @@ -33,4 +33,4 @@ octokit.rest.apps.createFromManifest({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#create-a-github-app-from-a-manifest). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest). diff --git a/docs/apps/createInstallationAccessToken.md b/docs/apps/createInstallationAccessToken.md index 3a4f52c1d..0772c1430 100644 --- a/docs/apps/createInstallationAccessToken.md +++ b/docs/apps/createInstallationAccessToken.md @@ -46,7 +46,7 @@ List of repository IDs that the token should have access to permissionsno -The permissions granted to the user-to-server access token. +The permissions granted to the user access token. permissions.actionsno @@ -222,4 +222,4 @@ The level of permission to grant the access token to manage team discussions and -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#create-an-installation-access-token-for-an-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app). diff --git a/docs/apps/deleteAuthorization.md b/docs/apps/deleteAuthorization.md index f19e87894..3318d9b35 100644 --- a/docs/apps/deleteAuthorization.md +++ b/docs/apps/deleteAuthorization.md @@ -42,4 +42,4 @@ The OAuth access token used to authenticate to the GitHub API. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#delete-an-app-authorization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization). diff --git a/docs/apps/deleteInstallation.md b/docs/apps/deleteInstallation.md index 9f76e9e2c..ff8d145cf 100644 --- a/docs/apps/deleteInstallation.md +++ b/docs/apps/deleteInstallation.md @@ -8,7 +8,7 @@ type: API method # Delete an installation for the authenticated app -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. +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/apps/apps#suspend-an-app-installation)" endpoint. 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. @@ -37,4 +37,4 @@ The unique identifier of the installation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#delete-an-installation-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#delete-an-installation-for-the-authenticated-app). diff --git a/docs/apps/deleteToken.md b/docs/apps/deleteToken.md index 473bd887f..33d7f6b3a 100644 --- a/docs/apps/deleteToken.md +++ b/docs/apps/deleteToken.md @@ -41,4 +41,4 @@ The OAuth access token used to authenticate to the GitHub API. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#delete-an-app-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token). diff --git a/docs/apps/getAuthenticated.md b/docs/apps/getAuthenticated.md index dd5697635..069a3df7b 100644 --- a/docs/apps/getAuthenticated.md +++ b/docs/apps/getAuthenticated.md @@ -8,7 +8,7 @@ type: API method # Get the authenticated app -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. +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/apps/apps#list-installations-for-the-authenticated-app)" endpoint. 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. @@ -20,4 +20,4 @@ octokit.rest.apps.getAuthenticated(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-the-authenticated-app). diff --git a/docs/apps/getBySlug.md b/docs/apps/getBySlug.md index 15a4fc9df..2cf95fc53 100644 --- a/docs/apps/getBySlug.md +++ b/docs/apps/getBySlug.md @@ -35,4 +35,4 @@ octokit.rest.apps.getBySlug({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps/#get-an-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-an-app). diff --git a/docs/apps/getInstallation.md b/docs/apps/getInstallation.md index e904a4770..b557d74e2 100644 --- a/docs/apps/getInstallation.md +++ b/docs/apps/getInstallation.md @@ -37,4 +37,4 @@ The unique identifier of the installation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-an-installation-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app). diff --git a/docs/apps/getOrgInstallation.md b/docs/apps/getOrgInstallation.md index 3dcb432e6..0139d1295 100644 --- a/docs/apps/getOrgInstallation.md +++ b/docs/apps/getOrgInstallation.md @@ -37,4 +37,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app). diff --git a/docs/apps/getRepoInstallation.md b/docs/apps/getRepoInstallation.md index e2e43f1ad..005a433a5 100644 --- a/docs/apps/getRepoInstallation.md +++ b/docs/apps/getRepoInstallation.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app). diff --git a/docs/apps/getSubscriptionPlanForAccount.md b/docs/apps/getSubscriptionPlanForAccount.md index 4f05009a3..16568bf4d 100644 --- a/docs/apps/getSubscriptionPlanForAccount.md +++ b/docs/apps/getSubscriptionPlanForAccount.md @@ -10,7 +10,7 @@ type: API method 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. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.getSubscriptionPlanForAccount({ @@ -37,4 +37,4 @@ account_id parameter -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account). diff --git a/docs/apps/getSubscriptionPlanForAccountStubbed.md b/docs/apps/getSubscriptionPlanForAccountStubbed.md index e6aa2d0dc..cbee7fffc 100644 --- a/docs/apps/getSubscriptionPlanForAccountStubbed.md +++ b/docs/apps/getSubscriptionPlanForAccountStubbed.md @@ -10,7 +10,7 @@ type: API method 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. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.getSubscriptionPlanForAccountStubbed({ @@ -37,4 +37,4 @@ account_id parameter -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-subscription-plan-for-an-account-stubbed). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed). diff --git a/docs/apps/getUserInstallation.md b/docs/apps/getUserInstallation.md index 5368e1d22..41c05c40a 100644 --- a/docs/apps/getUserInstallation.md +++ b/docs/apps/getUserInstallation.md @@ -37,4 +37,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-user-installation-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app). diff --git a/docs/apps/getWebhookConfigForApp.md b/docs/apps/getWebhookConfigForApp.md index dff8739fa..f0697f31a 100644 --- a/docs/apps/getWebhookConfigForApp.md +++ b/docs/apps/getWebhookConfigForApp.md @@ -20,4 +20,4 @@ octokit.rest.apps.getWebhookConfigForApp(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-webhook-configuration-for-an-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app). diff --git a/docs/apps/getWebhookDelivery.md b/docs/apps/getWebhookDelivery.md index b1e21e36f..667fefdb4 100644 --- a/docs/apps/getWebhookDelivery.md +++ b/docs/apps/getWebhookDelivery.md @@ -35,4 +35,4 @@ octokit.rest.apps.getWebhookDelivery({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#get-a-delivery-for-an-app-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook). diff --git a/docs/apps/listAccountsForPlan.md b/docs/apps/listAccountsForPlan.md index 7de4e6cdd..e507826f1 100644 --- a/docs/apps/listAccountsForPlan.md +++ b/docs/apps/listAccountsForPlan.md @@ -10,7 +10,7 @@ type: API method 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. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.listAccountsForPlan({ @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan). diff --git a/docs/apps/listAccountsForPlanStubbed.md b/docs/apps/listAccountsForPlanStubbed.md index 23d8f36d4..3df597334 100644 --- a/docs/apps/listAccountsForPlanStubbed.md +++ b/docs/apps/listAccountsForPlanStubbed.md @@ -10,7 +10,7 @@ type: API method 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. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.listAccountsForPlanStubbed({ @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-accounts-for-a-plan-stubbed). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed). diff --git a/docs/apps/listInstallationReposForAuthenticatedUser.md b/docs/apps/listInstallationReposForAuthenticatedUser.md index 2320b1583..119d1e8d5 100644 --- a/docs/apps/listInstallationReposForAuthenticatedUser.md +++ b/docs/apps/listInstallationReposForAuthenticatedUser.md @@ -12,7 +12,7 @@ List repositories that the authenticated user has explicit permission (`:read`, The 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. -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. +You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. The access the user has to each repository is included in the hash under the `permissions` key. @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-user-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-user-access-token). diff --git a/docs/apps/listInstallationRequestsForAuthenticatedApp.md b/docs/apps/listInstallationRequestsForAuthenticatedApp.md index fedaacf8f..02fbd7e18 100644 --- a/docs/apps/listInstallationRequestsForAuthenticatedApp.md +++ b/docs/apps/listInstallationRequestsForAuthenticatedApp.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-installation-requests-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app). diff --git a/docs/apps/listInstallations.md b/docs/apps/listInstallations.md index 7c39682ef..2b22f0981 100644 --- a/docs/apps/listInstallations.md +++ b/docs/apps/listInstallations.md @@ -8,7 +8,7 @@ type: API method # List installations for the authenticated app -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. +You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. The permissions the installation has are included under the `permissions` key. @@ -39,7 +39,7 @@ Page number of the results to fetch. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. outdatedno @@ -48,4 +48,4 @@ Only show notifications updated after the given time. This is a timestamp in [IS -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-installations-for-the-authenticated-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app). diff --git a/docs/apps/listInstallationsForAuthenticatedUser.md b/docs/apps/listInstallationsForAuthenticatedUser.md index 39660af69..93a86a35e 100644 --- a/docs/apps/listInstallationsForAuthenticatedUser.md +++ b/docs/apps/listInstallationsForAuthenticatedUser.md @@ -10,7 +10,7 @@ type: API method Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. -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. +You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. The 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. @@ -44,4 +44,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#list-app-installations-accessible-to-the-user-access-token). diff --git a/docs/apps/listPlans.md b/docs/apps/listPlans.md index 931a420b9..533840f36 100644 --- a/docs/apps/listPlans.md +++ b/docs/apps/listPlans.md @@ -10,7 +10,7 @@ type: API method Lists all plans that are part of your GitHub Marketplace listing. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.listPlans(); @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-plans). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-plans). diff --git a/docs/apps/listPlansStubbed.md b/docs/apps/listPlansStubbed.md index 88a4e12da..4fa2efadb 100644 --- a/docs/apps/listPlansStubbed.md +++ b/docs/apps/listPlansStubbed.md @@ -10,7 +10,7 @@ type: API method Lists all plans that are part of your GitHub Marketplace listing. -GitHub 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. +GitHub 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. ```js octokit.rest.apps.listPlansStubbed(); @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-plans-stubbed). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-plans-stubbed). diff --git a/docs/apps/listReposAccessibleToInstallation.md b/docs/apps/listReposAccessibleToInstallation.md index 1679aea5a..903b9cbbd 100644 --- a/docs/apps/listReposAccessibleToInstallation.md +++ b/docs/apps/listReposAccessibleToInstallation.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-repositories-accessible-to-the-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation). diff --git a/docs/apps/listSubscriptionsForAuthenticatedUser.md b/docs/apps/listSubscriptionsForAuthenticatedUser.md index b8cdb92c2..48233f578 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUser.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # List subscriptions for the authenticated user -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/). +Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). ```js octokit.rest.apps.listSubscriptionsForAuthenticatedUser(); @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user). diff --git a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md index 64d37496d..524d4c23b 100644 --- a/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md +++ b/docs/apps/listSubscriptionsForAuthenticatedUserStubbed.md @@ -8,7 +8,7 @@ type: API method # List subscriptions for the authenticated user (stubbed) -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/). +Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). ```js octokit.rest.apps.listSubscriptionsForAuthenticatedUserStubbed(); @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-subscriptions-for-the-authenticated-user-stubbed). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed). diff --git a/docs/apps/listWebhookDeliveries.md b/docs/apps/listWebhookDeliveries.md index a8b4580e8..ef2a51bad 100644 --- a/docs/apps/listWebhookDeliveries.md +++ b/docs/apps/listWebhookDeliveries.md @@ -43,4 +43,4 @@ Used for pagination: the starting delivery from which the page of deliveries is -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#list-deliveries-for-an-app-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook). diff --git a/docs/apps/redeliverWebhookDelivery.md b/docs/apps/redeliverWebhookDelivery.md index 87b3d41db..528c54825 100644 --- a/docs/apps/redeliverWebhookDelivery.md +++ b/docs/apps/redeliverWebhookDelivery.md @@ -35,4 +35,4 @@ octokit.rest.apps.redeliverWebhookDelivery({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook). diff --git a/docs/apps/removeRepoFromInstallation.md b/docs/apps/removeRepoFromInstallation.md index 6bf0c37c2..28dc8a963 100644 --- a/docs/apps/removeRepoFromInstallation.md +++ b/docs/apps/removeRepoFromInstallation.md @@ -45,4 +45,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation). diff --git a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md index 700b0a7af..ecdb7b821 100644 --- a/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md +++ b/docs/apps/removeRepoFromInstallationForAuthenticatedUser.md @@ -43,4 +43,4 @@ The unique identifier of the repository. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation). diff --git a/docs/apps/resetToken.md b/docs/apps/resetToken.md index fff782cfd..adb773045 100644 --- a/docs/apps/resetToken.md +++ b/docs/apps/resetToken.md @@ -41,4 +41,4 @@ The access_token of the OAuth or GitHub application. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#reset-a-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/oauth-applications#reset-a-token). diff --git a/docs/apps/revokeInstallationAccessToken.md b/docs/apps/revokeInstallationAccessToken.md index 503410f33..14f4e2e3d 100644 --- a/docs/apps/revokeInstallationAccessToken.md +++ b/docs/apps/revokeInstallationAccessToken.md @@ -10,7 +10,7 @@ type: API method Revokes the installation token you're using to authenticate as an installation and access this endpoint. -Once 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. +Once 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/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. You 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. @@ -22,4 +22,4 @@ octokit.rest.apps.revokeInstallationAccessToken(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#revoke-an-installation-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/installations#revoke-an-installation-access-token). diff --git a/docs/apps/scopeToken.md b/docs/apps/scopeToken.md index a29dd6be6..3c6625a45 100644 --- a/docs/apps/scopeToken.md +++ b/docs/apps/scopeToken.md @@ -8,7 +8,7 @@ type: API method # Create a scoped access token -Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. +Use a non-scoped user access token to create a repository scoped and/or permission scoped user 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. ```js octokit.rest.apps.scopeToken({ @@ -40,27 +40,27 @@ The access token used to authenticate to the GitHub API. targetno -The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified. +The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. target_idno -The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified. +The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. repositoriesno -The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified. +The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. repository_idsno -The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified. +The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. permissionsno -The permissions granted to the user-to-server access token. +The permissions granted to the user access token. permissions.actionsno diff --git a/docs/apps/suspendInstallation.md b/docs/apps/suspendInstallation.md index c38305c24..484a358b3 100644 --- a/docs/apps/suspendInstallation.md +++ b/docs/apps/suspendInstallation.md @@ -37,4 +37,4 @@ The unique identifier of the installation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#suspend-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation). diff --git a/docs/apps/unsuspendInstallation.md b/docs/apps/unsuspendInstallation.md index 218539c44..fab31f3fc 100644 --- a/docs/apps/unsuspendInstallation.md +++ b/docs/apps/unsuspendInstallation.md @@ -37,4 +37,4 @@ The unique identifier of the installation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#unsuspend-an-app-installation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation). diff --git a/docs/apps/updateWebhookConfigForApp.md b/docs/apps/updateWebhookConfigForApp.md index aa47533e3..d623c6726 100644 --- a/docs/apps/updateWebhookConfigForApp.md +++ b/docs/apps/updateWebhookConfigForApp.md @@ -48,4 +48,4 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/apps#update-a-webhook-configuration-for-an-app). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app). diff --git a/docs/billing/getGithubActionsBillingOrg.md b/docs/billing/getGithubActionsBillingOrg.md index b5776518c..23fba2ea1 100644 --- a/docs/billing/getGithubActionsBillingOrg.md +++ b/docs/billing/getGithubActionsBillingOrg.md @@ -39,4 +39,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization). diff --git a/docs/billing/getGithubActionsBillingUser.md b/docs/billing/getGithubActionsBillingUser.md index 4f77295ed..a95b3abce 100644 --- a/docs/billing/getGithubActionsBillingUser.md +++ b/docs/billing/getGithubActionsBillingUser.md @@ -39,4 +39,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-actions-billing-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user). diff --git a/docs/billing/getGithubPackagesBillingOrg.md b/docs/billing/getGithubPackagesBillingOrg.md index a71c765a0..3feb379a9 100644 --- a/docs/billing/getGithubPackagesBillingOrg.md +++ b/docs/billing/getGithubPackagesBillingOrg.md @@ -39,4 +39,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization). diff --git a/docs/billing/getGithubPackagesBillingUser.md b/docs/billing/getGithubPackagesBillingUser.md index 73ed09eb0..c62cc6fb4 100644 --- a/docs/billing/getGithubPackagesBillingUser.md +++ b/docs/billing/getGithubPackagesBillingUser.md @@ -39,4 +39,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-github-packages-billing-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user). diff --git a/docs/billing/getSharedStorageBillingOrg.md b/docs/billing/getSharedStorageBillingOrg.md index 6a99e5449..a2f4844e9 100644 --- a/docs/billing/getSharedStorageBillingOrg.md +++ b/docs/billing/getSharedStorageBillingOrg.md @@ -39,4 +39,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization). diff --git a/docs/billing/getSharedStorageBillingUser.md b/docs/billing/getSharedStorageBillingUser.md index 4dd8cc2fc..a576d1e89 100644 --- a/docs/billing/getSharedStorageBillingUser.md +++ b/docs/billing/getSharedStorageBillingUser.md @@ -39,4 +39,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/billing#get-shared-storage-billing-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user). diff --git a/docs/checks/create.md b/docs/checks/create.md index eae3accdc..ca98e7d80 100644 --- a/docs/checks/create.md +++ b/docs/checks/create.md @@ -1,6 +1,6 @@ --- name: Create a check run -example: octokit.rest.checks.create({ owner, repo }) +example: octokit.rest.checks.create({ owner, repo, name, head_sha, output.title, output.summary, output.annotations[].path, output.annotations[].start_line, output.annotations[].end_line, output.annotations[].annotation_level, output.annotations[].message, output.images[].alt, output.images[].image_url, actions[].label, actions[].description, actions[].identifier }) route: POST /repos/{owner}/{repo}/check-runs scope: checks type: API method @@ -16,9 +16,23 @@ In a check suite, GitHub limits the number of check runs with the same name to 1 ```js octokit.rest.checks.create({ - owner, - repo, -}); + owner, +repo, +name, +head_sha, +output.title, +output.summary, +output.annotations[].path, +output.annotations[].start_line, +output.annotations[].end_line, +output.annotations[].annotation_level, +output.annotations[].message, +output.images[].alt, +output.images[].image_url, +actions[].label, +actions[].description, +actions[].identifier + }) ``` ## Parameters @@ -39,13 +53,158 @@ The account owner of the repository. The name is not case sensitive. repoyes -The name of the repository without the `.git` extension. The name is not case sensitive. +The name of the repository. The name is not case sensitive. + + +nameyes + +The name of the check. For example, "code-coverage". + + +head_shayes + +The SHA of the commit. + + +details_urlno + +The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. + + +external_idno + +A reference for the run on the integrator's system. statusno +The current status. + + +started_atno + +The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + + +conclusionno + +**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. +**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + + +completed_atno + +The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + + +outputno + +Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. + + +output.titleyes + +The title of the check run. + + +output.summaryyes + +The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. + + +output.textno + +The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. + + +output.annotationsno + +Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". + + +output.annotations[].pathyes + +The path of the file to add an annotation to. For example, `assets/css/main.css`. + + +output.annotations[].start_lineyes + +The start line of the annotation. Line numbers start at 1. + -*no +output.annotations[].end_lineyes + +The end line of the annotation. + + +output.annotations[].start_columnno + +The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. + + +output.annotations[].end_columnno + +The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. + + +output.annotations[].annotation_levelyes + +The level of the annotation. + + +output.annotations[].messageyes + +A short description of the feedback for these lines of code. The maximum size is 64 KB. + + +output.annotations[].titleno + +The title that represents the annotation. The maximum size is 255 characters. + + +output.annotations[].raw_detailsno + +Details about this annotation. The maximum size is 64 KB. + + +output.imagesno + +Adds images to the output displayed in the GitHub pull request UI. + + +output.images[].altyes + +The alternative text for the image. + + +output.images[].image_urlyes + +The full URL of the image. + + +output.images[].captionno + +A short image description. + + +actionsno + +Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." + + +actions[].labelyes + +The text to be displayed on a button in the web UI. The maximum size is 20 characters. + + +actions[].descriptionyes + +A short explanation of what this action would do. The maximum size is 40 characters. + + +actions[].identifieryes + +A reference for the action on the integrator's system. The maximum size is 20 characters. diff --git a/docs/checks/createSuite.md b/docs/checks/createSuite.md index 619948167..dcbe9f621 100644 --- a/docs/checks/createSuite.md +++ b/docs/checks/createSuite.md @@ -10,7 +10,7 @@ type: API method **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`. -By 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. +By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/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/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. ```js octokit.rest.checks.createSuite({ @@ -49,4 +49,4 @@ The sha of the head commit. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#create-a-check-suite). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/suites#create-a-check-suite). diff --git a/docs/checks/get.md b/docs/checks/get.md index b98b4afd5..18f73a394 100644 --- a/docs/checks/get.md +++ b/docs/checks/get.md @@ -10,7 +10,7 @@ type: API method **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. -Gets 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. +Gets 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. ```js octokit.rest.checks.get({ @@ -49,4 +49,4 @@ The unique identifier of the check run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#get-a-check-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#get-a-check-run). diff --git a/docs/checks/getSuite.md b/docs/checks/getSuite.md index 39ed38892..0869ba178 100644 --- a/docs/checks/getSuite.md +++ b/docs/checks/getSuite.md @@ -10,7 +10,7 @@ type: API method **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`. -Gets 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. +Gets 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. ```js octokit.rest.checks.getSuite({ @@ -49,4 +49,4 @@ The unique identifier of the check suite. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#get-a-check-suite). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/suites#get-a-check-suite). diff --git a/docs/checks/listAnnotations.md b/docs/checks/listAnnotations.md index 04185bb73..d5c741c12 100644 --- a/docs/checks/listAnnotations.md +++ b/docs/checks/listAnnotations.md @@ -8,7 +8,7 @@ type: API method # List check run annotations -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. +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. ```js octokit.rest.checks.listAnnotations({ @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#list-check-run-annotations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#list-check-run-annotations). diff --git a/docs/checks/listForRef.md b/docs/checks/listForRef.md index 838459050..d95f4f953 100644 --- a/docs/checks/listForRef.md +++ b/docs/checks/listForRef.md @@ -10,7 +10,7 @@ type: API method **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. -Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. +Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. ```js octokit.rest.checks.listForRef({ @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. check_nameno @@ -77,4 +77,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#list-check-runs-for-a-git-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference). diff --git a/docs/checks/listForSuite.md b/docs/checks/listForSuite.md index 0a51a0eb8..ce2366487 100644 --- a/docs/checks/listForSuite.md +++ b/docs/checks/listForSuite.md @@ -10,7 +10,7 @@ type: API method **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. -Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. +Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. ```js octokit.rest.checks.listForSuite({ @@ -74,4 +74,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite). diff --git a/docs/checks/listSuitesForRef.md b/docs/checks/listSuitesForRef.md index c7b09b9d5..457e62edd 100644 --- a/docs/checks/listSuitesForRef.md +++ b/docs/checks/listSuitesForRef.md @@ -10,7 +10,7 @@ type: API method **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`. -Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. +Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. ```js octokit.rest.checks.listSuitesForRef({ @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. app_idno @@ -69,4 +69,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference). diff --git a/docs/checks/rerequestRun.md b/docs/checks/rerequestRun.md index 13cb8580c..8f53c4c07 100644 --- a/docs/checks/rerequestRun.md +++ b/docs/checks/rerequestRun.md @@ -12,6 +12,8 @@ Triggers GitHub to rerequest an existing check run, without pushing new code to To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. +For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + ```js octokit.rest.checks.rerequestRun({ owner, @@ -49,4 +51,4 @@ The unique identifier of the check run. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#rerequest-a-check-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#rerequest-a-check-run). diff --git a/docs/checks/rerequestSuite.md b/docs/checks/rerequestSuite.md index fa43ace59..5c2115389 100644 --- a/docs/checks/rerequestSuite.md +++ b/docs/checks/rerequestSuite.md @@ -10,7 +10,7 @@ type: API method 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. -To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. +To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. ```js octokit.rest.checks.rerequestSuite({ @@ -49,4 +49,4 @@ The unique identifier of the check suite. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#rerequest-a-check-suite). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/suites#rerequest-a-check-suite). diff --git a/docs/checks/setSuitesPreferences.md b/docs/checks/setSuitesPreferences.md index 195a2d6ab..ca0072328 100644 --- a/docs/checks/setSuitesPreferences.md +++ b/docs/checks/setSuitesPreferences.md @@ -8,7 +8,7 @@ type: API method # Update repository preferences for check suites -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. +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/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. ```js octokit.rest.checks.setSuitesPreferences({ @@ -58,4 +58,4 @@ Set to `true` to enable automatic creation of CheckSuite events upon pushes to t -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#update-repository-preferences-for-check-suites). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites). diff --git a/docs/checks/update.md b/docs/checks/update.md index df197123d..a080d5e52 100644 --- a/docs/checks/update.md +++ b/docs/checks/update.md @@ -115,7 +115,7 @@ Can contain Markdown. output.annotationsno -Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". +Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". output.annotations[].pathyes @@ -185,7 +185,7 @@ A short image description. actionsno -Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." +Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." actions[].labelyes @@ -206,4 +206,4 @@ A reference for the action on the integrator's system. The maximum size is 20 ch -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/checks#update-a-check-run). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/checks/runs#update-a-check-run). diff --git a/docs/codeScanning/deleteAnalysis.md b/docs/codeScanning/deleteAnalysis.md index 01406abaa..98dbba8d5 100644 --- a/docs/codeScanning/deleteAnalysis.md +++ b/docs/codeScanning/deleteAnalysis.md @@ -118,4 +118,4 @@ Allow deletion if the specified analysis is the last in a set. If you attempt to -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository). diff --git a/docs/codeScanning/getAlert.md b/docs/codeScanning/getAlert.md index 0f0d4a893..59570dffb 100644 --- a/docs/codeScanning/getAlert.md +++ b/docs/codeScanning/getAlert.md @@ -52,4 +52,4 @@ The number that identifies an alert. You can find this at the end of the URL for -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert). diff --git a/docs/codeScanning/getAnalysis.md b/docs/codeScanning/getAnalysis.md index 4ffcc5498..81240cea9 100644 --- a/docs/codeScanning/getAnalysis.md +++ b/docs/codeScanning/getAnalysis.md @@ -65,4 +65,4 @@ The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-sca -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository). diff --git a/docs/codeScanning/getCodeqlDatabase.md b/docs/codeScanning/getCodeqlDatabase.md index 65d4e611e..ad1d27153 100644 --- a/docs/codeScanning/getCodeqlDatabase.md +++ b/docs/codeScanning/getCodeqlDatabase.md @@ -57,4 +57,4 @@ The language of the CodeQL database. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#get-a-codeql-database-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository). diff --git a/docs/codeScanning/getDefaultSetup.md b/docs/codeScanning/getDefaultSetup.md index 03eefeeec..afb12ea3d 100644 --- a/docs/codeScanning/getDefaultSetup.md +++ b/docs/codeScanning/getDefaultSetup.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning#get-a-code-scanning-default-setup-configuration). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration). diff --git a/docs/codeScanning/getSarif.md b/docs/codeScanning/getSarif.md index c68569d90..31bd66f7f 100644 --- a/docs/codeScanning/getSarif.md +++ b/docs/codeScanning/getSarif.md @@ -8,7 +8,7 @@ type: API method # Get information about a SARIF upload -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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. +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/code-scanning/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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. ```js octokit.rest.codeScanning.getSarif({ @@ -47,4 +47,4 @@ The SARIF ID obtained after uploading. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#get-information-about-a-sarif-upload). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload). diff --git a/docs/codeScanning/listAlertInstances.md b/docs/codeScanning/listAlertInstances.md index 4f3a2f209..6f651daf3 100644 --- a/docs/codeScanning/listAlertInstances.md +++ b/docs/codeScanning/listAlertInstances.md @@ -65,4 +65,4 @@ The Git reference for the results you want to list. The `ref` for a branch can b -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert). diff --git a/docs/codeScanning/listAlertsForOrg.md b/docs/codeScanning/listAlertsForOrg.md index 9b6b1ad00..b34f47b74 100644 --- a/docs/codeScanning/listAlertsForOrg.md +++ b/docs/codeScanning/listAlertsForOrg.md @@ -91,4 +91,4 @@ If specified, only code scanning alerts with this severity will be returned. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization). diff --git a/docs/codeScanning/listAlertsInstances.md b/docs/codeScanning/listAlertsInstances.md index dc5096e2e..77a8cf0a0 100644 --- a/docs/codeScanning/listAlertsInstances.md +++ b/docs/codeScanning/listAlertsInstances.md @@ -67,4 +67,4 @@ The Git reference for the results you want to list. The `ref` for a branch can b -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert). diff --git a/docs/codeScanning/listCodeqlDatabases.md b/docs/codeScanning/listCodeqlDatabases.md index e887b23a5..fcfb976d3 100644 --- a/docs/codeScanning/listCodeqlDatabases.md +++ b/docs/codeScanning/listCodeqlDatabases.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-codeql-databases-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository). diff --git a/docs/codeScanning/listRecentAnalyses.md b/docs/codeScanning/listRecentAnalyses.md index aee3204da..75a1350bd 100644 --- a/docs/codeScanning/listRecentAnalyses.md +++ b/docs/codeScanning/listRecentAnalyses.md @@ -97,4 +97,4 @@ The property by which to sort the results. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository). diff --git a/docs/codeScanning/updateAlert.md b/docs/codeScanning/updateAlert.md index 93cf4169e..05e8d32d4 100644 --- a/docs/codeScanning/updateAlert.md +++ b/docs/codeScanning/updateAlert.md @@ -63,4 +63,4 @@ The dismissal comment associated with the dismissal of the alert. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert). diff --git a/docs/codeScanning/updateDefaultSetup.md b/docs/codeScanning/updateDefaultSetup.md index 238116e69..b5e0da851 100644 --- a/docs/codeScanning/updateDefaultSetup.md +++ b/docs/codeScanning/updateDefaultSetup.md @@ -50,8 +50,13 @@ Whether code scanning default setup has been configured or not. CodeQL query suite to be used. + +languagesno + +CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`. + -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning#update-a-code-scanning-default-setup-configuration). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration). diff --git a/docs/codeScanning/uploadSarif.md b/docs/codeScanning/uploadSarif.md index f65f1ed12..7505d0c0e 100644 --- a/docs/codeScanning/uploadSarif.md +++ b/docs/codeScanning/uploadSarif.md @@ -8,7 +8,7 @@ type: API method # Upload an analysis as SARIF data -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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. +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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." There are two places where you can upload code scanning results. @@ -23,7 +23,7 @@ gzip -c analysis-data.sarif | base64 -w0
SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. -To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. +To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." | **SARIF data** | **Maximum values** | **Additional limits** | | -------------------------------- | :----------------: | -------------------------------------------------------------------------------- | @@ -37,7 +37,7 @@ To get the most out of your analysis when it includes data above the supported l The `202 Accepted` response includes an `id` value. You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. -For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." +For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." ```js octokit.rest.codeScanning.uploadSarif({ @@ -111,4 +111,4 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#upload-an-analysis-as-sarif-data). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data). diff --git a/docs/codesOfConduct/getAllCodesOfConduct.md b/docs/codesOfConduct/getAllCodesOfConduct.md index d41d62776..4f1a3ac82 100644 --- a/docs/codesOfConduct/getAllCodesOfConduct.md +++ b/docs/codesOfConduct/getAllCodesOfConduct.md @@ -8,6 +8,8 @@ type: API method # Get all codes of conduct +Returns array of all GitHub's codes of conduct. + ```js octokit.rest.codesOfConduct.getAllCodesOfConduct(); ``` @@ -16,4 +18,4 @@ octokit.rest.codesOfConduct.getAllCodesOfConduct(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct). diff --git a/docs/codesOfConduct/getConductCode.md b/docs/codesOfConduct/getConductCode.md index 564449c9b..079b4a08f 100644 --- a/docs/codesOfConduct/getConductCode.md +++ b/docs/codesOfConduct/getConductCode.md @@ -8,6 +8,8 @@ type: API method # Get a code of conduct +Returns information about the specified GitHub code of conduct. + ```js octokit.rest.codesOfConduct.getConductCode({ key, @@ -31,4 +33,4 @@ octokit.rest.codesOfConduct.getConductCode({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct). diff --git a/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md index 68a9373f8..b0ea74a77 100644 --- a/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md +++ b/docs/codespaces/addRepositoryForSecretForAuthenticatedUser.md @@ -41,4 +41,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret). diff --git a/docs/codespaces/addSelectedRepoToOrgSecret.md b/docs/codespaces/addSelectedRepoToOrgSecret.md index 9a16c9157..3beea7f5f 100644 --- a/docs/codespaces/addSelectedRepoToOrgSecret.md +++ b/docs/codespaces/addSelectedRepoToOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Add selected repository to an organization secret -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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.addSelectedRepoToOrgSecret({ @@ -45,4 +45,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#add-selected-repository-to-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret). diff --git a/docs/codespaces/codespaceMachinesForAuthenticatedUser.md b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md index b1ca8094b..54849fac7 100644 --- a/docs/codespaces/codespaceMachinesForAuthenticatedUser.md +++ b/docs/codespaces/codespaceMachinesForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace). diff --git a/docs/codespaces/createForAuthenticatedUser.md b/docs/codespaces/createForAuthenticatedUser.md index c36e8863c..66e360818 100644 --- a/docs/codespaces/createForAuthenticatedUser.md +++ b/docs/codespaces/createForAuthenticatedUser.md @@ -114,4 +114,4 @@ Repository id for this codespace -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/createOrUpdateOrgSecret.md b/docs/codespaces/createOrUpdateOrgSecret.md index 4b6811c18..f011e7c94 100644 --- a/docs/codespaces/createOrUpdateOrgSecret.md +++ b/docs/codespaces/createOrUpdateOrgSecret.md @@ -9,80 +9,10 @@ type: API method # Create or update an organization secret Creates or updates an organization secret with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access -token with the `admin:org` scope to use this endpoint. - -**Example encrypting a secret using Node.js** - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -**Example encrypting a secret using Python** - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -**Example encrypting a secret using C#** - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." -**Example encrypting a secret using Ruby** - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` +You must authenticate using an access +token with the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.createOrUpdateOrgSecret({ @@ -115,7 +45,7 @@ The name of the secret. encrypted_valueno -The 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 organization public key](https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key) endpoint. +The 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 organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. key_idno @@ -130,10 +60,10 @@ Which type of organization repositories have access to the organization secret. selected_repository_idsno -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 manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. +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 manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). diff --git a/docs/codespaces/createOrUpdateRepoSecret.md b/docs/codespaces/createOrUpdateRepoSecret.md index 9c5b1d3e0..51c53d3bb 100644 --- a/docs/codespaces/createOrUpdateRepoSecret.md +++ b/docs/codespaces/createOrUpdateRepoSecret.md @@ -9,82 +9,12 @@ type: API method # Create or update a repository secret Creates or updates a repository secret with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. -#### Example of encrypting a secret using Node.js - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -#### Example of encrypting a secret using Python - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -#### Example of encrypting a secret using C# - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` - -#### Example of encrypting a secret using Ruby - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` - ```js octokit.rest.codespaces.createOrUpdateRepoSecret({ owner, @@ -121,7 +51,7 @@ The name of the secret. encrypted_valueno -Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint. +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. key_idno @@ -132,4 +62,4 @@ ID of the key you used to encrypt the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-or-update-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret). diff --git a/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md index f608130e4..da58b3c91 100644 --- a/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md +++ b/docs/codespaces/createOrUpdateSecretForAuthenticatedUser.md @@ -9,84 +9,12 @@ type: API method # Create or update a secret for the authenticated user Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. -**Example encrypting a secret using Node.js** - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -**Example encrypting a secret using Python** - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -**Example encrypting a secret using C#** - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` - -**Example encrypting a secret using Ruby** - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` - ```js octokit.rest.codespaces.createOrUpdateSecretForAuthenticatedUser({ secret_name, @@ -112,7 +40,7 @@ The name of the secret. encrypted_valueno -Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint. +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. key_idyes @@ -122,10 +50,10 @@ ID of the key you used to encrypt the secret. selected_repository_idsno -An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. +An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/createWithPrForAuthenticatedUser.md b/docs/codespaces/createWithPrForAuthenticatedUser.md index c597ec4ca..c3319cc70 100644 --- a/docs/codespaces/createWithPrForAuthenticatedUser.md +++ b/docs/codespaces/createWithPrForAuthenticatedUser.md @@ -101,4 +101,4 @@ Duration in minutes after codespace has gone idle in which it will be deleted. M -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request). diff --git a/docs/codespaces/createWithRepoForAuthenticatedUser.md b/docs/codespaces/createWithRepoForAuthenticatedUser.md index 87f745bd5..fc629371b 100644 --- a/docs/codespaces/createWithRepoForAuthenticatedUser.md +++ b/docs/codespaces/createWithRepoForAuthenticatedUser.md @@ -100,4 +100,4 @@ Duration in minutes after codespace has gone idle in which it will be deleted. M -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository). diff --git a/docs/codespaces/deleteCodespacesBillingUsers.md b/docs/codespaces/deleteCodespacesBillingUsers.md deleted file mode 100644 index 1cea4cb2d..000000000 --- a/docs/codespaces/deleteCodespacesBillingUsers.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Removes users from Codespaces billing for an organization -example: octokit.rest.codespaces.deleteCodespacesBillingUsers({ org, selected_usernames }) -route: DELETE /orgs/{org}/codespaces/billing/selected_users -scope: codespaces -type: API method ---- - -# Removes users from Codespaces billing for an organization - -Codespaces for the specified users will no longer be billed to the organization. -To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -```js -octokit.rest.codespaces.deleteCodespacesBillingUsers({ - org, - selected_usernames, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
selected_usernamesyes - -The usernames of the organization members whose codespaces should not be billed to the organization. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-codespaces-billing-users). diff --git a/docs/codespaces/deleteForAuthenticatedUser.md b/docs/codespaces/deleteForAuthenticatedUser.md index 862054716..fb1b5846a 100644 --- a/docs/codespaces/deleteForAuthenticatedUser.md +++ b/docs/codespaces/deleteForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/deleteFromOrganization.md b/docs/codespaces/deleteFromOrganization.md index 264776661..00797167e 100644 --- a/docs/codespaces/deleteFromOrganization.md +++ b/docs/codespaces/deleteFromOrganization.md @@ -49,4 +49,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization). diff --git a/docs/codespaces/deleteOrgSecret.md b/docs/codespaces/deleteOrgSecret.md index 473a6e883..caeed6c81 100644 --- a/docs/codespaces/deleteOrgSecret.md +++ b/docs/codespaces/deleteOrgSecret.md @@ -41,4 +41,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret). diff --git a/docs/codespaces/deleteRepoSecret.md b/docs/codespaces/deleteRepoSecret.md index 53e8e4031..96f60ca4b 100644 --- a/docs/codespaces/deleteRepoSecret.md +++ b/docs/codespaces/deleteRepoSecret.md @@ -47,4 +47,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret). diff --git a/docs/codespaces/deleteSecretForAuthenticatedUser.md b/docs/codespaces/deleteSecretForAuthenticatedUser.md index e4a83d231..64b8820a5 100644 --- a/docs/codespaces/deleteSecretForAuthenticatedUser.md +++ b/docs/codespaces/deleteSecretForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/getCodespacesForUserInOrg.md b/docs/codespaces/getCodespacesForUserInOrg.md index 20a8296a0..f7c5cd433 100644 --- a/docs/codespaces/getCodespacesForUserInOrg.md +++ b/docs/codespaces/getCodespacesForUserInOrg.md @@ -53,4 +53,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-codespaces-for-user-in-org). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization). diff --git a/docs/codespaces/getForAuthenticatedUser.md b/docs/codespaces/getForAuthenticatedUser.md index a8808af23..a0c302cea 100644 --- a/docs/codespaces/getForAuthenticatedUser.md +++ b/docs/codespaces/getForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/getOrgPublicKey.md b/docs/codespaces/getOrgPublicKey.md index 11439cea2..65e0c9e9c 100644 --- a/docs/codespaces/getOrgPublicKey.md +++ b/docs/codespaces/getOrgPublicKey.md @@ -35,4 +35,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key). diff --git a/docs/codespaces/getOrgSecret.md b/docs/codespaces/getOrgSecret.md index c617141b1..abb41d101 100644 --- a/docs/codespaces/getOrgSecret.md +++ b/docs/codespaces/getOrgSecret.md @@ -42,4 +42,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret). diff --git a/docs/codespaces/getPublicKeyForAuthenticatedUser.md b/docs/codespaces/getPublicKeyForAuthenticatedUser.md index 168c15184..b158ce678 100644 --- a/docs/codespaces/getPublicKeyForAuthenticatedUser.md +++ b/docs/codespaces/getPublicKeyForAuthenticatedUser.md @@ -22,4 +22,4 @@ octokit.rest.codespaces.getPublicKeyForAuthenticatedUser(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user). diff --git a/docs/codespaces/getRepoPublicKey.md b/docs/codespaces/getRepoPublicKey.md index 3d5a8a6c7..12f5d2298 100644 --- a/docs/codespaces/getRepoPublicKey.md +++ b/docs/codespaces/getRepoPublicKey.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key). diff --git a/docs/codespaces/getRepoSecret.md b/docs/codespaces/getRepoSecret.md index 9a46483c4..74ad36f3d 100644 --- a/docs/codespaces/getRepoSecret.md +++ b/docs/codespaces/getRepoSecret.md @@ -47,4 +47,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret). diff --git a/docs/codespaces/getSecretForAuthenticatedUser.md b/docs/codespaces/getSecretForAuthenticatedUser.md index 92207b503..1e178cc1a 100644 --- a/docs/codespaces/getSecretForAuthenticatedUser.md +++ b/docs/codespaces/getSecretForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user). diff --git a/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md index dab611860..b44781903 100644 --- a/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md +++ b/docs/codespaces/listDevcontainersInRepositoryForAuthenticatedUser.md @@ -56,4 +56,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user). diff --git a/docs/codespaces/listForAuthenticatedUser.md b/docs/codespaces/listForAuthenticatedUser.md index 69b561743..95013b7ba 100644 --- a/docs/codespaces/listForAuthenticatedUser.md +++ b/docs/codespaces/listForAuthenticatedUser.md @@ -47,4 +47,4 @@ ID of the Repository to filter on -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user). diff --git a/docs/codespaces/listInOrganization.md b/docs/codespaces/listInOrganization.md index 5be10d00e..357f860f9 100644 --- a/docs/codespaces/listInOrganization.md +++ b/docs/codespaces/listInOrganization.md @@ -52,4 +52,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-in-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization). diff --git a/docs/codespaces/listInRepositoryForAuthenticatedUser.md b/docs/codespaces/listInRepositoryForAuthenticatedUser.md index 44be8391c..fa821b61b 100644 --- a/docs/codespaces/listInRepositoryForAuthenticatedUser.md +++ b/docs/codespaces/listInRepositoryForAuthenticatedUser.md @@ -55,4 +55,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user). diff --git a/docs/codespaces/listOrgSecrets.md b/docs/codespaces/listOrgSecrets.md index c42c9a26d..b827fdae9 100644 --- a/docs/codespaces/listOrgSecrets.md +++ b/docs/codespaces/listOrgSecrets.md @@ -46,4 +46,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-organization-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets). diff --git a/docs/codespaces/listRepoSecrets.md b/docs/codespaces/listRepoSecrets.md index 21e2527a1..28ca43918 100644 --- a/docs/codespaces/listRepoSecrets.md +++ b/docs/codespaces/listRepoSecrets.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-repository-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets). diff --git a/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md index fc553b519..abf8cdf1c 100644 --- a/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md +++ b/docs/codespaces/listRepositoriesForSecretForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret). diff --git a/docs/codespaces/listSecretsForAuthenticatedUser.md b/docs/codespaces/listSecretsForAuthenticatedUser.md index 6ef47f5d6..9d6055d80 100644 --- a/docs/codespaces/listSecretsForAuthenticatedUser.md +++ b/docs/codespaces/listSecretsForAuthenticatedUser.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user). diff --git a/docs/codespaces/listSelectedReposForOrgSecret.md b/docs/codespaces/listSelectedReposForOrgSecret.md index b7e48cc2e..af960bb53 100644 --- a/docs/codespaces/listSelectedReposForOrgSecret.md +++ b/docs/codespaces/listSelectedReposForOrgSecret.md @@ -51,4 +51,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret). diff --git a/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md b/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md index c9844f2c4..fb45c6e60 100644 --- a/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md +++ b/docs/codespaces/preFlightWithRepoForAuthenticatedUser.md @@ -55,4 +55,4 @@ An alternative IP for default location auto-detection, such as when proxying a r -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace). diff --git a/docs/codespaces/publishForAuthenticatedUser.md b/docs/codespaces/publishForAuthenticatedUser.md index dfb075699..697a9cf1d 100644 --- a/docs/codespaces/publishForAuthenticatedUser.md +++ b/docs/codespaces/publishForAuthenticatedUser.md @@ -53,4 +53,4 @@ Whether the new repository should be private. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace). diff --git a/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md index 68f77823c..a1402ea17 100644 --- a/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md +++ b/docs/codespaces/removeRepositoryForSecretForAuthenticatedUser.md @@ -41,4 +41,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret). diff --git a/docs/codespaces/removeSelectedRepoFromOrgSecret.md b/docs/codespaces/removeSelectedRepoFromOrgSecret.md index 5c3e78111..ee67edfe1 100644 --- a/docs/codespaces/removeSelectedRepoFromOrgSecret.md +++ b/docs/codespaces/removeSelectedRepoFromOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Remove selected repository from an organization secret -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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.removeSelectedRepoFromOrgSecret({ @@ -45,4 +45,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret). diff --git a/docs/codespaces/repoMachinesForAuthenticatedUser.md b/docs/codespaces/repoMachinesForAuthenticatedUser.md index 173138b89..5a2646d4e 100644 --- a/docs/codespaces/repoMachinesForAuthenticatedUser.md +++ b/docs/codespaces/repoMachinesForAuthenticatedUser.md @@ -51,8 +51,13 @@ The location to check for available machines. Assigned by IP if not provided. IP for location auto-detection when proxying a request + +refno + +The branch or commit to check for prebuild availability and devcontainer restrictions. + -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository). diff --git a/docs/codespaces/setCodespacesBilling.md b/docs/codespaces/setCodespacesBilling.md deleted file mode 100644 index 9a1399c13..000000000 --- a/docs/codespaces/setCodespacesBilling.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Manage access control for organization codespaces -example: octokit.rest.codespaces.setCodespacesBilling({ org, visibility }) -route: PUT /orgs/{org}/codespaces/billing -scope: codespaces -type: API method ---- - -# Manage access control for organization codespaces - -Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility. -You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -```js -octokit.rest.codespaces.setCodespacesBilling({ - org, - visibility, -}); -``` - -## Parameters - - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
visibilityyes - -Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. - -
selected_usernamesno - -The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#set-codespaces-billing). diff --git a/docs/codespaces/setCodespacesBillingUsers.md b/docs/codespaces/setCodespacesBillingUsers.md deleted file mode 100644 index 876a4086b..000000000 --- a/docs/codespaces/setCodespacesBillingUsers.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Add users to Codespaces billing for an organization -example: octokit.rest.codespaces.setCodespacesBillingUsers({ org, selected_usernames }) -route: POST /orgs/{org}/codespaces/billing/selected_users -scope: codespaces -type: API method ---- - -# Add users to Codespaces billing for an organization - -Codespaces for the specified users will be billed to the organization. -To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint. - -```js -octokit.rest.codespaces.setCodespacesBillingUsers({ - org, - selected_usernames, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
orgyes - -The organization name. The name is not case sensitive. - -
selected_usernamesyes - -The usernames of the organization members whose codespaces be billed to the organization. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#set-codespaces-billing-users). diff --git a/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md index be55870be..5024f2743 100644 --- a/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md +++ b/docs/codespaces/setRepositoriesForSecretForAuthenticatedUser.md @@ -39,10 +39,10 @@ The name of the secret. selected_repository_idsyes -An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints. +An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret). diff --git a/docs/codespaces/setSelectedReposForOrgSecret.md b/docs/codespaces/setSelectedReposForOrgSecret.md index 441e4f7b5..1be3fedf1 100644 --- a/docs/codespaces/setSelectedReposForOrgSecret.md +++ b/docs/codespaces/setSelectedReposForOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Set selected repositories for an organization secret -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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. +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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. ```js octokit.rest.codespaces.setSelectedReposForOrgSecret({ @@ -41,10 +41,10 @@ The name of the secret. 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/codespaces#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints. +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/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret). diff --git a/docs/codespaces/startForAuthenticatedUser.md b/docs/codespaces/startForAuthenticatedUser.md index a2511d425..4f05e4c49 100644 --- a/docs/codespaces/startForAuthenticatedUser.md +++ b/docs/codespaces/startForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/stopForAuthenticatedUser.md b/docs/codespaces/stopForAuthenticatedUser.md index cec008f16..edcb59665 100644 --- a/docs/codespaces/stopForAuthenticatedUser.md +++ b/docs/codespaces/stopForAuthenticatedUser.md @@ -39,4 +39,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user). diff --git a/docs/codespaces/stopInOrganization.md b/docs/codespaces/stopInOrganization.md index f7f14832d..2dcb10e27 100644 --- a/docs/codespaces/stopInOrganization.md +++ b/docs/codespaces/stopInOrganization.md @@ -49,4 +49,4 @@ The name of the codespace. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user). diff --git a/docs/codespaces/updateForAuthenticatedUser.md b/docs/codespaces/updateForAuthenticatedUser.md index 673cb607d..803a30082 100644 --- a/docs/codespaces/updateForAuthenticatedUser.md +++ b/docs/codespaces/updateForAuthenticatedUser.md @@ -56,4 +56,4 @@ Recently opened folders inside the codespace. It is currently used by the client -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user). diff --git a/docs/copilot/addCopilotForBusinessSeatsForTeams.md b/docs/copilot/addCopilotForBusinessSeatsForTeams.md new file mode 100644 index 000000000..75b694499 --- /dev/null +++ b/docs/copilot/addCopilotForBusinessSeatsForTeams.md @@ -0,0 +1,54 @@ +--- +name: Add teams to the Copilot for Business subscription for an organization +example: octokit.rest.copilot.addCopilotForBusinessSeatsForTeams({ org, selected_teams }) +route: POST /orgs/{org}/copilot/billing/selected_teams +scope: copilot +type: API method +--- + +# Add teams to the Copilot for Business subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Purchases a GitHub Copilot for Business seat for all users within each specified team. +The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + +Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. +For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". +For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + +```js +octokit.rest.copilot.addCopilotForBusinessSeatsForTeams({ + org, + selected_teams, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
selected_teamsyes + +List of team names within the organization to which to grant access to GitHub Copilot. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/copilot/addCopilotForBusinessSeatsForUsers.md b/docs/copilot/addCopilotForBusinessSeatsForUsers.md new file mode 100644 index 000000000..828ed0c86 --- /dev/null +++ b/docs/copilot/addCopilotForBusinessSeatsForUsers.md @@ -0,0 +1,54 @@ +--- +name: Add users to the Copilot for Business subscription for an organization +example: octokit.rest.copilot.addCopilotForBusinessSeatsForUsers({ org, selected_usernames }) +route: POST /orgs/{org}/copilot/billing/selected_users +scope: copilot +type: API method +--- + +# Add users to the Copilot for Business subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Purchases a GitHub Copilot for Business seat for each user specified. +The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + +Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. +For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". +For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + +```js +octokit.rest.copilot.addCopilotForBusinessSeatsForUsers({ + org, + selected_usernames, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
selected_usernamesyes + +The usernames of the organization members to be granted access to GitHub Copilot. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/copilot/cancelCopilotSeatAssignmentForTeams.md b/docs/copilot/cancelCopilotSeatAssignmentForTeams.md new file mode 100644 index 000000000..80c208606 --- /dev/null +++ b/docs/copilot/cancelCopilotSeatAssignmentForTeams.md @@ -0,0 +1,54 @@ +--- +name: Remove teams from the Copilot for Business subscription for an organization +example: octokit.rest.copilot.cancelCopilotSeatAssignmentForTeams({ org, selected_teams }) +route: DELETE /orgs/{org}/copilot/billing/selected_teams +scope: copilot +type: API method +--- + +# Remove teams from the Copilot for Business subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Cancels the Copilot for Business seat assignment for all members of each team specified. +This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + +For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + +For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + +Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.cancelCopilotSeatAssignmentForTeams({ + org, + selected_teams, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
selected_teamsyes + +The names of teams from which to revoke access to GitHub Copilot. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/copilot/cancelCopilotSeatAssignmentForUsers.md b/docs/copilot/cancelCopilotSeatAssignmentForUsers.md new file mode 100644 index 000000000..fa631b458 --- /dev/null +++ b/docs/copilot/cancelCopilotSeatAssignmentForUsers.md @@ -0,0 +1,54 @@ +--- +name: Remove users from the Copilot for Business subscription for an organization +example: octokit.rest.copilot.cancelCopilotSeatAssignmentForUsers({ org, selected_usernames }) +route: DELETE /orgs/{org}/copilot/billing/selected_users +scope: copilot +type: API method +--- + +# Remove users from the Copilot for Business subscription for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Cancels the Copilot for Business seat assignment for each user specified. +This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + +For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + +For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + +Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.cancelCopilotSeatAssignmentForUsers({ + org, + selected_usernames, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
selected_usernamesyes + +The usernames of the organization members for which to revoke access to GitHub Copilot. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization). diff --git a/docs/copilot/getCopilotOrganizationDetails.md b/docs/copilot/getCopilotOrganizationDetails.md new file mode 100644 index 000000000..8c506b07a --- /dev/null +++ b/docs/copilot/getCopilotOrganizationDetails.md @@ -0,0 +1,45 @@ +--- +name: Get Copilot for Business seat information and settings for an organization +example: octokit.rest.copilot.getCopilotOrganizationDetails({ org }) +route: GET /orgs/{org}/copilot/billing +scope: copilot +type: API method +--- + +# Get Copilot for Business seat information and settings for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Gets information about an organization's Copilot for Business subscription, including seat breakdown +and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. +For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + +Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.getCopilotOrganizationDetails({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization). diff --git a/docs/copilot/getCopilotSeatAssignmentDetailsForUser.md b/docs/copilot/getCopilotSeatAssignmentDetailsForUser.md new file mode 100644 index 000000000..56ca2b90b --- /dev/null +++ b/docs/copilot/getCopilotSeatAssignmentDetailsForUser.md @@ -0,0 +1,48 @@ +--- +name: Get Copilot for Business seat assignment details for a user +example: octokit.rest.copilot.getCopilotSeatAssignmentDetailsForUser({ org, username }) +route: GET /orgs/{org}/members/{username}/copilot +scope: copilot +type: API method +--- + +# Get Copilot for Business seat assignment details for a user + +**Note**: This endpoint is in beta and is subject to change. + +Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + +Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.getCopilotSeatAssignmentDetailsForUser({ + org, + username, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
usernameyes + +The handle for the GitHub user account. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user). diff --git a/docs/copilot/listCopilotSeats.md b/docs/copilot/listCopilotSeats.md new file mode 100644 index 000000000..e7415cce0 --- /dev/null +++ b/docs/copilot/listCopilotSeats.md @@ -0,0 +1,53 @@ +--- +name: List all Copilot for Business seat assignments for an organization +example: octokit.rest.copilot.listCopilotSeats({ org }) +route: GET /orgs/{org}/copilot/billing/seats +scope: copilot +type: API method +--- + +# List all Copilot for Business seat assignments for an organization + +**Note**: This endpoint is in beta and is subject to change. + +Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + +Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must +authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + +```js +octokit.rest.copilot.listCopilotSeats({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
pageno + +Page number of the results to fetch. + +
per_pageno + +The number of results per page (max 100). + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization). diff --git a/docs/dependabot/addSelectedRepoToOrgSecret.md b/docs/dependabot/addSelectedRepoToOrgSecret.md index 6523c3e72..4a2d57255 100644 --- a/docs/dependabot/addSelectedRepoToOrgSecret.md +++ b/docs/dependabot/addSelectedRepoToOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Add selected repository to an organization secret -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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. +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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. ```js octokit.rest.dependabot.addSelectedRepoToOrgSecret({ @@ -45,4 +45,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret). diff --git a/docs/dependabot/createOrUpdateRepoSecret.md b/docs/dependabot/createOrUpdateRepoSecret.md index 727cd7dc6..22440aa97 100644 --- a/docs/dependabot/createOrUpdateRepoSecret.md +++ b/docs/dependabot/createOrUpdateRepoSecret.md @@ -9,82 +9,12 @@ type: API method # Create or update a repository secret Creates or updates a repository secret with an encrypted value. Encrypt your secret using -[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access +[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + +You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. -**Example encrypting a secret using Node.js** - -Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - -``` -const sodium = require('libsodium-wrappers') -const secret = 'plain-text-secret' // replace with the secret you want to encrypt -const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - -//Check if libsodium is ready and then proceed. -sodium.ready.then(() => { - // Convert Secret & Base64 key to Uint8Array. - let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - let binsec = sodium.from_string(secret) - - //Encrypt the secret using LibSodium - let encBytes = sodium.crypto_box_seal(binsec, binkey) - - // Convert encrypted Uint8Array to Base64 - let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - - console.log(output) -}); -``` - -**Example encrypting a secret using Python** - -Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - -``` -from base64 import b64encode -from nacl import encoding, public - -def encrypt(public_key: str, secret_value: str) -> str: - """Encrypt a Unicode string using the public key.""" - public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - sealed_box = public.SealedBox(public_key) - encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - return b64encode(encrypted).decode("utf-8") -``` - -**Example encrypting a secret using C#** - -Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - -``` -var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); -var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - -var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - -Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); -``` - -**Example encrypting a secret using Ruby** - -Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - -```ruby -require "rbnacl" -require "base64" - -key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") -public_key = RbNaCl::PublicKey.new(key) - -box = RbNaCl::Boxes::Sealed.from_public_key(public_key) -encrypted_secret = box.encrypt("my_secret") - -# Print the base64 encoded secret -puts Base64.strict_encode64(encrypted_secret) -``` - ```js octokit.rest.dependabot.createOrUpdateRepoSecret({ owner, @@ -121,7 +51,7 @@ The name of the secret. encrypted_valueno -Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint. +Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. key_idno @@ -132,4 +62,4 @@ ID of the key you used to encrypt the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret). diff --git a/docs/dependabot/deleteOrgSecret.md b/docs/dependabot/deleteOrgSecret.md index a23038de6..50681a0d2 100644 --- a/docs/dependabot/deleteOrgSecret.md +++ b/docs/dependabot/deleteOrgSecret.md @@ -41,4 +41,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret). diff --git a/docs/dependabot/deleteRepoSecret.md b/docs/dependabot/deleteRepoSecret.md index 9884661af..a7f2a4bb9 100644 --- a/docs/dependabot/deleteRepoSecret.md +++ b/docs/dependabot/deleteRepoSecret.md @@ -47,4 +47,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret). diff --git a/docs/dependabot/getAlert.md b/docs/dependabot/getAlert.md index 0e992ec32..08dec3da5 100644 --- a/docs/dependabot/getAlert.md +++ b/docs/dependabot/getAlert.md @@ -52,4 +52,4 @@ or in `number` fields in the response from the -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-a-dependabot-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert). diff --git a/docs/dependabot/getOrgPublicKey.md b/docs/dependabot/getOrgPublicKey.md index 5a85dfc9d..6784e7f62 100644 --- a/docs/dependabot/getOrgPublicKey.md +++ b/docs/dependabot/getOrgPublicKey.md @@ -35,4 +35,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key). diff --git a/docs/dependabot/getOrgSecret.md b/docs/dependabot/getOrgSecret.md index 5689d35db..37f85421a 100644 --- a/docs/dependabot/getOrgSecret.md +++ b/docs/dependabot/getOrgSecret.md @@ -41,4 +41,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret). diff --git a/docs/dependabot/getRepoPublicKey.md b/docs/dependabot/getRepoPublicKey.md index e352fd880..b0a09368c 100644 --- a/docs/dependabot/getRepoPublicKey.md +++ b/docs/dependabot/getRepoPublicKey.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key). diff --git a/docs/dependabot/getRepoSecret.md b/docs/dependabot/getRepoSecret.md index cec5ac453..4102bee77 100644 --- a/docs/dependabot/getRepoSecret.md +++ b/docs/dependabot/getRepoSecret.md @@ -47,4 +47,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#get-a-repository-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret). diff --git a/docs/dependabot/listAlertsForRepo.md b/docs/dependabot/listAlertsForRepo.md index 4b3b9f16a..d0a4e74e4 100644 --- a/docs/dependabot/listAlertsForRepo.md +++ b/docs/dependabot/listAlertsForRepo.md @@ -125,4 +125,4 @@ Instead, use `per_page` in combination with `before` to fetch the last page of r -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository). diff --git a/docs/dependabot/listOrgSecrets.md b/docs/dependabot/listOrgSecrets.md index 77cdfc939..c3d97fe60 100644 --- a/docs/dependabot/listOrgSecrets.md +++ b/docs/dependabot/listOrgSecrets.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-organization-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#list-organization-secrets). diff --git a/docs/dependabot/listRepoSecrets.md b/docs/dependabot/listRepoSecrets.md index a46917b82..15db5d7ed 100644 --- a/docs/dependabot/listRepoSecrets.md +++ b/docs/dependabot/listRepoSecrets.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-repository-secrets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#list-repository-secrets). diff --git a/docs/dependabot/listSelectedReposForOrgSecret.md b/docs/dependabot/listSelectedReposForOrgSecret.md index 797546ae4..88df94629 100644 --- a/docs/dependabot/listSelectedReposForOrgSecret.md +++ b/docs/dependabot/listSelectedReposForOrgSecret.md @@ -51,4 +51,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret). diff --git a/docs/dependabot/removeSelectedRepoFromOrgSecret.md b/docs/dependabot/removeSelectedRepoFromOrgSecret.md index 38824d0b0..f04e3b33f 100644 --- a/docs/dependabot/removeSelectedRepoFromOrgSecret.md +++ b/docs/dependabot/removeSelectedRepoFromOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Remove selected repository from an organization secret -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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. +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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. ```js octokit.rest.dependabot.removeSelectedRepoFromOrgSecret({ @@ -45,4 +45,4 @@ The name of the secret. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret). diff --git a/docs/dependabot/setSelectedReposForOrgSecret.md b/docs/dependabot/setSelectedReposForOrgSecret.md index f8133ad3b..efdca8837 100644 --- a/docs/dependabot/setSelectedReposForOrgSecret.md +++ b/docs/dependabot/setSelectedReposForOrgSecret.md @@ -8,7 +8,7 @@ type: API method # Set selected repositories for an organization secret -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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. +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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. ```js octokit.rest.dependabot.setSelectedReposForOrgSecret({ @@ -41,10 +41,10 @@ The name of the secret. 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/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints. +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/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret). diff --git a/docs/dependabot/updateAlert.md b/docs/dependabot/updateAlert.md index 27dc13d7d..4db605317 100644 --- a/docs/dependabot/updateAlert.md +++ b/docs/dependabot/updateAlert.md @@ -71,4 +71,4 @@ An optional comment associated with dismissing the alert. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependabot#update-a-dependabot-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert). diff --git a/docs/dependencyGraph/createRepositorySnapshot.md b/docs/dependencyGraph/createRepositorySnapshot.md index 947015313..efc2d8249 100644 --- a/docs/dependencyGraph/createRepositorySnapshot.md +++ b/docs/dependencyGraph/createRepositorySnapshot.md @@ -184,4 +184,4 @@ The time at which the snapshot was scanned. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository). diff --git a/docs/dependencyGraph/diffRange.md b/docs/dependencyGraph/diffRange.md index c631032f1..7c7b0e682 100644 --- a/docs/dependencyGraph/diffRange.md +++ b/docs/dependencyGraph/diffRange.md @@ -52,4 +52,4 @@ The full path, relative to the repository root, of the dependency manifest file. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/dependency-graph#get-a-diff-of-the-dependencies-between-commits). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits). diff --git a/docs/emojis/get.md b/docs/emojis/get.md index f60322063..4c08e31c1 100644 --- a/docs/emojis/get.md +++ b/docs/emojis/get.md @@ -18,4 +18,4 @@ octokit.rest.emojis.get(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/emojis#get-emojis). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/emojis/emojis#get-emojis). diff --git a/docs/gists/checkIsStarred.md b/docs/gists/checkIsStarred.md index 1802a9e2b..bd02022db 100644 --- a/docs/gists/checkIsStarred.md +++ b/docs/gists/checkIsStarred.md @@ -33,4 +33,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred). diff --git a/docs/gists/create.md b/docs/gists/create.md index 5237eb58f..a09c5df90 100644 --- a/docs/gists/create.md +++ b/docs/gists/create.md @@ -54,4 +54,4 @@ Content of the file -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#create-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#create-a-gist). diff --git a/docs/gists/createComment.md b/docs/gists/createComment.md index 4402b6d8b..73f57bda6 100644 --- a/docs/gists/createComment.md +++ b/docs/gists/createComment.md @@ -39,4 +39,4 @@ The comment text. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#create-a-gist-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/comments#create-a-gist-comment). diff --git a/docs/gists/delete.md b/docs/gists/delete.md index 56fa5bb50..c5de7cf19 100644 --- a/docs/gists/delete.md +++ b/docs/gists/delete.md @@ -33,4 +33,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#delete-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#delete-a-gist). diff --git a/docs/gists/deleteComment.md b/docs/gists/deleteComment.md index 6c5ba2c7e..54e925c1a 100644 --- a/docs/gists/deleteComment.md +++ b/docs/gists/deleteComment.md @@ -39,4 +39,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#delete-a-gist-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/comments#delete-a-gist-comment). diff --git a/docs/gists/fork.md b/docs/gists/fork.md index 11ff2be2e..e40e77265 100644 --- a/docs/gists/fork.md +++ b/docs/gists/fork.md @@ -33,4 +33,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#fork-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#fork-a-gist). diff --git a/docs/gists/get.md b/docs/gists/get.md index 9fc9b9e52..a6aa3ee2b 100644 --- a/docs/gists/get.md +++ b/docs/gists/get.md @@ -33,4 +33,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#get-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#get-a-gist). diff --git a/docs/gists/getComment.md b/docs/gists/getComment.md index bd7f87788..885677136 100644 --- a/docs/gists/getComment.md +++ b/docs/gists/getComment.md @@ -39,4 +39,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#get-a-gist-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/comments#get-a-gist-comment). diff --git a/docs/gists/getRevision.md b/docs/gists/getRevision.md index cade7f8bf..af08cda7b 100644 --- a/docs/gists/getRevision.md +++ b/docs/gists/getRevision.md @@ -37,4 +37,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#get-a-gist-revision). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#get-a-gist-revision). diff --git a/docs/gists/list.md b/docs/gists/list.md index deda928d2..ef2fd15cf 100644 --- a/docs/gists/list.md +++ b/docs/gists/list.md @@ -27,7 +27,7 @@ octokit.rest.gists.list(); sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-gists-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user). diff --git a/docs/gists/listComments.md b/docs/gists/listComments.md index 2a02869b5..8a6f4ff3f 100644 --- a/docs/gists/listComments.md +++ b/docs/gists/listComments.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-gist-comments). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/comments#list-gist-comments). diff --git a/docs/gists/listCommits.md b/docs/gists/listCommits.md index 07f8a9c9c..b35517039 100644 --- a/docs/gists/listCommits.md +++ b/docs/gists/listCommits.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-gist-commits). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-gist-commits). diff --git a/docs/gists/listForUser.md b/docs/gists/listForUser.md index 5134ae360..76cb40ff1 100644 --- a/docs/gists/listForUser.md +++ b/docs/gists/listForUser.md @@ -34,7 +34,7 @@ The handle for the GitHub user account. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-gists-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-gists-for-a-user). diff --git a/docs/gists/listForks.md b/docs/gists/listForks.md index 338d0c3a4..662521356 100644 --- a/docs/gists/listForks.md +++ b/docs/gists/listForks.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-gist-forks). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-gist-forks). diff --git a/docs/gists/listPublic.md b/docs/gists/listPublic.md index 4ce81dd93..1b4d05ed0 100644 --- a/docs/gists/listPublic.md +++ b/docs/gists/listPublic.md @@ -29,7 +29,7 @@ octokit.rest.gists.listPublic(); sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-public-gists). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-public-gists). diff --git a/docs/gists/listStarred.md b/docs/gists/listStarred.md index 81ed2fb5e..ab8ed3df4 100644 --- a/docs/gists/listStarred.md +++ b/docs/gists/listStarred.md @@ -27,7 +27,7 @@ octokit.rest.gists.listStarred(); sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#list-starred-gists). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#list-starred-gists). diff --git a/docs/gists/star.md b/docs/gists/star.md index 3d0054a8e..1b2e14a88 100644 --- a/docs/gists/star.md +++ b/docs/gists/star.md @@ -35,4 +35,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#star-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#star-a-gist). diff --git a/docs/gists/unstar.md b/docs/gists/unstar.md index 60c54a948..6bb9635fc 100644 --- a/docs/gists/unstar.md +++ b/docs/gists/unstar.md @@ -33,4 +33,4 @@ The unique identifier of the gist. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#unstar-a-gist). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/gists#unstar-a-gist). diff --git a/docs/gists/updateComment.md b/docs/gists/updateComment.md index 68cf20c3a..3aae80f9b 100644 --- a/docs/gists/updateComment.md +++ b/docs/gists/updateComment.md @@ -45,4 +45,4 @@ The comment text. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gists#update-a-gist-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gists/comments#update-a-gist-comment). diff --git a/docs/git/createBlob.md b/docs/git/createBlob.md index acb8f91ac..9dfcddaec 100644 --- a/docs/git/createBlob.md +++ b/docs/git/createBlob.md @@ -50,4 +50,4 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#create-a-blob). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/blobs#create-a-blob). diff --git a/docs/git/createCommit.md b/docs/git/createCommit.md index 689548977..128b7dc03 100644 --- a/docs/git/createCommit.md +++ b/docs/git/createCommit.md @@ -8,7 +8,7 @@ type: API method # Create a commit -Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). +Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). **Signature verification object** @@ -134,4 +134,4 @@ The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the co -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#create-a-commit). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/commits#create-a-commit). diff --git a/docs/git/createRef.md b/docs/git/createRef.md index 6485a2c41..8951215d0 100644 --- a/docs/git/createRef.md +++ b/docs/git/createRef.md @@ -53,4 +53,4 @@ The SHA1 value for this reference. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#create-a-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/refs#create-a-reference). diff --git a/docs/git/createTag.md b/docs/git/createTag.md index 99c9e310f..9d70c6fd8 100644 --- a/docs/git/createTag.md +++ b/docs/git/createTag.md @@ -8,7 +8,7 @@ type: API method # Create a tag object -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. +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/git/refs#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/git/refs#create-a-reference) the tag reference - this call would be unnecessary. **Signature verification object** @@ -116,4 +116,4 @@ When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipe -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#create-a-tag-object). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/tags#create-a-tag-object). diff --git a/docs/git/createTree.md b/docs/git/createTree.md index 250d909f5..9df74cb92 100644 --- a/docs/git/createTree.md +++ b/docs/git/createTree.md @@ -10,7 +10,7 @@ type: API method 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. -If 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)." +If 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/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." Returns an error if you try to delete a file that does not exist. @@ -86,4 +86,4 @@ If not provided, GitHub will create a new Git tree object from only the entries -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#create-a-tree). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/trees#create-a-tree). diff --git a/docs/git/deleteRef.md b/docs/git/deleteRef.md index cafcb71a3..ea387ab04 100644 --- a/docs/git/deleteRef.md +++ b/docs/git/deleteRef.md @@ -39,10 +39,10 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#delete-a-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/refs#delete-a-reference). diff --git a/docs/git/getBlob.md b/docs/git/getBlob.md index 1196bce9b..1c5eca8ef 100644 --- a/docs/git/getBlob.md +++ b/docs/git/getBlob.md @@ -47,4 +47,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#get-a-blob). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/blobs#get-a-blob). diff --git a/docs/git/getCommit.md b/docs/git/getCommit.md index 5f5b8ae54..5721840a4 100644 --- a/docs/git/getCommit.md +++ b/docs/git/getCommit.md @@ -1,14 +1,16 @@ --- -name: Get a commit +name: Get a commit object example: octokit.rest.git.getCommit({ owner, repo, commit_sha }) route: GET /repos/{owner}/{repo}/git/commits/{commit_sha} scope: git type: API method --- -# Get a commit +# Get a commit object -Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). +Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + +To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." **Signature verification object** @@ -76,4 +78,4 @@ The SHA of the commit. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#get-a-commit). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/commits#get-a-commit-object). diff --git a/docs/git/getRef.md b/docs/git/getRef.md index f4cce7c20..784f7a291 100644 --- a/docs/git/getRef.md +++ b/docs/git/getRef.md @@ -10,7 +10,7 @@ type: API method 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. -**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)". +**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/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)". ```js octokit.rest.git.getRef({ @@ -43,10 +43,10 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#get-a-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/refs#get-a-reference). diff --git a/docs/git/getTag.md b/docs/git/getTag.md index 742281970..f0ecc8b23 100644 --- a/docs/git/getTag.md +++ b/docs/git/getTag.md @@ -72,4 +72,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#get-a-tag). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/tags#get-a-tag). diff --git a/docs/git/getTree.md b/docs/git/getTree.md index 5e89626a9..5edef9226 100644 --- a/docs/git/getTree.md +++ b/docs/git/getTree.md @@ -8,7 +8,7 @@ type: API method # Get a tree -Returns a single tree using the SHA1 value for that tree. +Returns a single tree using the SHA1 value or ref name for that tree. If `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. @@ -45,6 +45,8 @@ The name of the repository without the `.git` extension. The name is not case se tree_shayes +The SHA1 value or ref (branch or tag) name of the tree. + recursiveno @@ -54,4 +56,4 @@ Setting this parameter to any value returns the objects or subtrees referenced b -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#get-a-tree). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/trees#get-a-tree). diff --git a/docs/git/listMatchingRefs.md b/docs/git/listMatchingRefs.md index 01ee9e78e..65549a998 100644 --- a/docs/git/listMatchingRefs.md +++ b/docs/git/listMatchingRefs.md @@ -12,7 +12,7 @@ Returns an array of references from your Git database that match the supplied na When 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`. -**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)". +**Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/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)". If 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`. @@ -47,10 +47,10 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#list-matching-references). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/refs#list-matching-references). diff --git a/docs/git/updateRef.md b/docs/git/updateRef.md index d3c02441e..2d16a0fb5 100644 --- a/docs/git/updateRef.md +++ b/docs/git/updateRef.md @@ -40,7 +40,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected. +The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. shayes @@ -56,4 +56,4 @@ Indicates whether to force the update or to make sure the update is a fast-forwa -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/git#update-a-reference). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/git/refs#update-a-reference). diff --git a/docs/gitignore/getAllTemplates.md b/docs/gitignore/getAllTemplates.md index 2f7ed2949..8e87eb202 100644 --- a/docs/gitignore/getAllTemplates.md +++ b/docs/gitignore/getAllTemplates.md @@ -8,7 +8,7 @@ type: API method # Get all gitignore templates -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). +List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). ```js octokit.rest.gitignore.getAllTemplates(); @@ -18,4 +18,4 @@ octokit.rest.gitignore.getAllTemplates(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gitignore#get-all-gitignore-templates). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates). diff --git a/docs/gitignore/getTemplate.md b/docs/gitignore/getTemplate.md index afa80e6c4..52319f79d 100644 --- a/docs/gitignore/getTemplate.md +++ b/docs/gitignore/getTemplate.md @@ -34,4 +34,4 @@ octokit.rest.gitignore.getTemplate({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/gitignore#get-a-gitignore-template). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template). diff --git a/docs/interactions/getRestrictionsForAuthenticatedUser.md b/docs/interactions/getRestrictionsForAuthenticatedUser.md index b997dc608..758b38428 100644 --- a/docs/interactions/getRestrictionsForAuthenticatedUser.md +++ b/docs/interactions/getRestrictionsForAuthenticatedUser.md @@ -18,4 +18,4 @@ octokit.rest.interactions.getRestrictionsForAuthenticatedUser(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories). diff --git a/docs/interactions/getRestrictionsForOrg.md b/docs/interactions/getRestrictionsForOrg.md index 6b4d1000f..106e39cae 100644 --- a/docs/interactions/getRestrictionsForOrg.md +++ b/docs/interactions/getRestrictionsForOrg.md @@ -35,4 +35,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization). diff --git a/docs/interactions/getRestrictionsForRepo.md b/docs/interactions/getRestrictionsForRepo.md index 2634ee79e..4e5a8a05a 100644 --- a/docs/interactions/getRestrictionsForRepo.md +++ b/docs/interactions/getRestrictionsForRepo.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository). diff --git a/docs/interactions/getRestrictionsForYourPublicRepos.md b/docs/interactions/getRestrictionsForYourPublicRepos.md index 9167c3c46..2d9e764d8 100644 --- a/docs/interactions/getRestrictionsForYourPublicRepos.md +++ b/docs/interactions/getRestrictionsForYourPublicRepos.md @@ -20,4 +20,4 @@ octokit.rest.interactions.getRestrictionsForYourPublicRepos(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories). diff --git a/docs/interactions/removeRestrictionsForAuthenticatedUser.md b/docs/interactions/removeRestrictionsForAuthenticatedUser.md index 28716bb17..556573f93 100644 --- a/docs/interactions/removeRestrictionsForAuthenticatedUser.md +++ b/docs/interactions/removeRestrictionsForAuthenticatedUser.md @@ -18,4 +18,4 @@ octokit.rest.interactions.removeRestrictionsForAuthenticatedUser(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories). diff --git a/docs/interactions/removeRestrictionsForOrg.md b/docs/interactions/removeRestrictionsForOrg.md index f86789378..9ff2fcd9c 100644 --- a/docs/interactions/removeRestrictionsForOrg.md +++ b/docs/interactions/removeRestrictionsForOrg.md @@ -35,4 +35,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization). diff --git a/docs/interactions/removeRestrictionsForRepo.md b/docs/interactions/removeRestrictionsForRepo.md index 793f304ff..2f2978d8b 100644 --- a/docs/interactions/removeRestrictionsForRepo.md +++ b/docs/interactions/removeRestrictionsForRepo.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository). diff --git a/docs/interactions/removeRestrictionsForYourPublicRepos.md b/docs/interactions/removeRestrictionsForYourPublicRepos.md index cd63abf25..410669ce9 100644 --- a/docs/interactions/removeRestrictionsForYourPublicRepos.md +++ b/docs/interactions/removeRestrictionsForYourPublicRepos.md @@ -20,4 +20,4 @@ octokit.rest.interactions.removeRestrictionsForYourPublicRepos(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories). diff --git a/docs/interactions/setRestrictionsForAuthenticatedUser.md b/docs/interactions/setRestrictionsForAuthenticatedUser.md index aa1c414a4..f3fdcf6b0 100644 --- a/docs/interactions/setRestrictionsForAuthenticatedUser.md +++ b/docs/interactions/setRestrictionsForAuthenticatedUser.md @@ -40,4 +40,4 @@ The duration of the interaction restriction. Default: `one_day`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories). diff --git a/docs/interactions/setRestrictionsForOrg.md b/docs/interactions/setRestrictionsForOrg.md index 3dfefb58c..a2c3036a7 100644 --- a/docs/interactions/setRestrictionsForOrg.md +++ b/docs/interactions/setRestrictionsForOrg.md @@ -46,4 +46,4 @@ The duration of the interaction restriction. Default: `one_day`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization). diff --git a/docs/interactions/setRestrictionsForRepo.md b/docs/interactions/setRestrictionsForRepo.md index 6d935374b..f2620176b 100644 --- a/docs/interactions/setRestrictionsForRepo.md +++ b/docs/interactions/setRestrictionsForRepo.md @@ -52,4 +52,4 @@ The duration of the interaction restriction. Default: `one_day`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository). diff --git a/docs/interactions/setRestrictionsForYourPublicRepos.md b/docs/interactions/setRestrictionsForYourPublicRepos.md index eaab01084..bc9a6e5e7 100644 --- a/docs/interactions/setRestrictionsForYourPublicRepos.md +++ b/docs/interactions/setRestrictionsForYourPublicRepos.md @@ -42,4 +42,4 @@ The duration of the interaction restriction. Default: `one_day`. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories). diff --git a/docs/issues/addAssignees.md b/docs/issues/addAssignees.md index 4a807d89a..92135b378 100644 --- a/docs/issues/addAssignees.md +++ b/docs/issues/addAssignees.md @@ -52,4 +52,4 @@ Usernames of people to assign this issue to. _NOTE: Only users with push access -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue). diff --git a/docs/issues/addLabels.md b/docs/issues/addLabels.md index 17becb52b..ebde35ff0 100644 --- a/docs/issues/addLabels.md +++ b/docs/issues/addLabels.md @@ -54,4 +54,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#add-labels-to-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue). diff --git a/docs/issues/checkUserCanBeAssigned.md b/docs/issues/checkUserCanBeAssigned.md index b96fd3be1..152dd5cf3 100644 --- a/docs/issues/checkUserCanBeAssigned.md +++ b/docs/issues/checkUserCanBeAssigned.md @@ -49,4 +49,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned). diff --git a/docs/issues/checkUserCanBeAssignedToIssue.md b/docs/issues/checkUserCanBeAssignedToIssue.md index 792e77c63..68ea645d2 100644 --- a/docs/issues/checkUserCanBeAssignedToIssue.md +++ b/docs/issues/checkUserCanBeAssignedToIssue.md @@ -55,4 +55,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue). diff --git a/docs/issues/create.md b/docs/issues/create.md index 88ee36178..b8da82418 100644 --- a/docs/issues/create.md +++ b/docs/issues/create.md @@ -72,4 +72,4 @@ Logins for Users to assign to this issue. _NOTE: Only users with push access can -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#create-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#create-an-issue). diff --git a/docs/issues/createComment.md b/docs/issues/createComment.md index f14c0e1a6..b25444771 100644 --- a/docs/issues/createComment.md +++ b/docs/issues/createComment.md @@ -59,4 +59,4 @@ The contents of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#create-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#create-an-issue-comment). diff --git a/docs/issues/createLabel.md b/docs/issues/createLabel.md index df6ae369f..806722391 100644 --- a/docs/issues/createLabel.md +++ b/docs/issues/createLabel.md @@ -57,4 +57,4 @@ A short description of the label. Must be 100 characters or fewer. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#create-a-label). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#create-a-label). diff --git a/docs/issues/createMilestone.md b/docs/issues/createMilestone.md index d169b2f41..e7290130d 100644 --- a/docs/issues/createMilestone.md +++ b/docs/issues/createMilestone.md @@ -62,4 +62,4 @@ The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.o -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#create-a-milestone). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/milestones#create-a-milestone). diff --git a/docs/issues/deleteComment.md b/docs/issues/deleteComment.md index 411cf39db..ac72f7586 100644 --- a/docs/issues/deleteComment.md +++ b/docs/issues/deleteComment.md @@ -47,4 +47,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#delete-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#delete-an-issue-comment). diff --git a/docs/issues/deleteLabel.md b/docs/issues/deleteLabel.md index 203c97065..a1695ae41 100644 --- a/docs/issues/deleteLabel.md +++ b/docs/issues/deleteLabel.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#delete-a-label). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#delete-a-label). diff --git a/docs/issues/deleteMilestone.md b/docs/issues/deleteMilestone.md index ab1f94ef5..5d4a054d3 100644 --- a/docs/issues/deleteMilestone.md +++ b/docs/issues/deleteMilestone.md @@ -47,4 +47,4 @@ The number that identifies the milestone. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#delete-a-milestone). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/milestones#delete-a-milestone). diff --git a/docs/issues/get.md b/docs/issues/get.md index 12250a8c5..86af69459 100644 --- a/docs/issues/get.md +++ b/docs/issues/get.md @@ -18,7 +18,7 @@ to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webho **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 -request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. +request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. ```js octokit.rest.issues.get({ @@ -57,4 +57,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#get-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#get-an-issue). diff --git a/docs/issues/getComment.md b/docs/issues/getComment.md index dd92e471b..b6f258c36 100644 --- a/docs/issues/getComment.md +++ b/docs/issues/getComment.md @@ -47,4 +47,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#get-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#get-an-issue-comment). diff --git a/docs/issues/getEvent.md b/docs/issues/getEvent.md index 835593761..8902933ca 100644 --- a/docs/issues/getEvent.md +++ b/docs/issues/getEvent.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#get-an-issue-event). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/events#get-an-issue-event). diff --git a/docs/issues/getLabel.md b/docs/issues/getLabel.md index 76aa23451..1f56f3596 100644 --- a/docs/issues/getLabel.md +++ b/docs/issues/getLabel.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#get-a-label). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#get-a-label). diff --git a/docs/issues/getMilestone.md b/docs/issues/getMilestone.md index e2399e4f9..30a85bdf1 100644 --- a/docs/issues/getMilestone.md +++ b/docs/issues/getMilestone.md @@ -47,4 +47,4 @@ The number that identifies the milestone. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#get-a-milestone). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/milestones#get-a-milestone). diff --git a/docs/issues/list.md b/docs/issues/list.md index 9702f1a37..ae32b94d9 100644 --- a/docs/issues/list.md +++ b/docs/issues/list.md @@ -15,7 +15,7 @@ necessarily assigned to you. **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 -request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. +request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. ```js octokit.rest.issues.list(); @@ -59,7 +59,7 @@ The direction to sort the results by. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. collabno @@ -87,4 +87,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user). diff --git a/docs/issues/listAssignees.md b/docs/issues/listAssignees.md index 9faf029ba..9993e7091 100644 --- a/docs/issues/listAssignees.md +++ b/docs/issues/listAssignees.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-assignees). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/assignees#list-assignees). diff --git a/docs/issues/listComments.md b/docs/issues/listComments.md index db15bf25b..ecb878c9d 100644 --- a/docs/issues/listComments.md +++ b/docs/issues/listComments.md @@ -48,7 +48,7 @@ The number that identifies the issue. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -64,4 +64,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-issue-comments). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#list-issue-comments). diff --git a/docs/issues/listCommentsForRepo.md b/docs/issues/listCommentsForRepo.md index 6ae205c3c..639fcdd26 100644 --- a/docs/issues/listCommentsForRepo.md +++ b/docs/issues/listCommentsForRepo.md @@ -52,7 +52,7 @@ Either `asc` or `desc`. Ignored without the `sort` parameter. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -68,4 +68,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository). diff --git a/docs/issues/listEvents.md b/docs/issues/listEvents.md index 1b448c463..4720097a4 100644 --- a/docs/issues/listEvents.md +++ b/docs/issues/listEvents.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-issue-events). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/events#list-issue-events). diff --git a/docs/issues/listEventsForRepo.md b/docs/issues/listEventsForRepo.md index 7c7dcc0f9..79f75c014 100644 --- a/docs/issues/listEventsForRepo.md +++ b/docs/issues/listEventsForRepo.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository). diff --git a/docs/issues/listEventsForTimeline.md b/docs/issues/listEventsForTimeline.md index 311a3dc05..6ede2bd09 100644 --- a/docs/issues/listEventsForTimeline.md +++ b/docs/issues/listEventsForTimeline.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue). diff --git a/docs/issues/listForAuthenticatedUser.md b/docs/issues/listForAuthenticatedUser.md index 0779aebfb..e2bea40bb 100644 --- a/docs/issues/listForAuthenticatedUser.md +++ b/docs/issues/listForAuthenticatedUser.md @@ -13,7 +13,7 @@ List issues across owned and member repositories assigned to the authenticated u **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 -request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. +request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. ```js octokit.rest.issues.listForAuthenticatedUser(); @@ -57,7 +57,7 @@ The direction to sort the results by. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -73,4 +73,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user). diff --git a/docs/issues/listForOrg.md b/docs/issues/listForOrg.md index 803c2d56c..6856edac2 100644 --- a/docs/issues/listForOrg.md +++ b/docs/issues/listForOrg.md @@ -13,7 +13,7 @@ List issues in an organization assigned to the authenticated user. **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 -request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. +request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. ```js octokit.rest.issues.listForOrg({ @@ -64,7 +64,7 @@ The direction to sort the results by. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -80,4 +80,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user). diff --git a/docs/issues/listForRepo.md b/docs/issues/listForRepo.md index bc6e18924..5b1b5cbd3 100644 --- a/docs/issues/listForRepo.md +++ b/docs/issues/listForRepo.md @@ -13,7 +13,7 @@ List issues in a repository. Only open issues will be listed. **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 -request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. +request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. ```js octokit.rest.issues.listForRepo({ @@ -85,7 +85,7 @@ The direction to sort the results by. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -101,4 +101,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-repository-issues). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#list-repository-issues). diff --git a/docs/issues/listLabelsForMilestone.md b/docs/issues/listLabelsForMilestone.md index dcf3b1039..31eeeae16 100644 --- a/docs/issues/listLabelsForMilestone.md +++ b/docs/issues/listLabelsForMilestone.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone). diff --git a/docs/issues/listLabelsForRepo.md b/docs/issues/listLabelsForRepo.md index 8ee04d92d..060e7efae 100644 --- a/docs/issues/listLabelsForRepo.md +++ b/docs/issues/listLabelsForRepo.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-labels-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#list-labels-for-a-repository). diff --git a/docs/issues/listLabelsOnIssue.md b/docs/issues/listLabelsOnIssue.md index 0f1c9a05c..6667b789a 100644 --- a/docs/issues/listLabelsOnIssue.md +++ b/docs/issues/listLabelsOnIssue.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-labels-for-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#list-labels-for-an-issue). diff --git a/docs/issues/listMilestones.md b/docs/issues/listMilestones.md index f40a70cb7..e386750d3 100644 --- a/docs/issues/listMilestones.md +++ b/docs/issues/listMilestones.md @@ -66,4 +66,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#list-milestones). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/milestones#list-milestones). diff --git a/docs/issues/lock.md b/docs/issues/lock.md index 3d723a229..68d7ce7af 100644 --- a/docs/issues/lock.md +++ b/docs/issues/lock.md @@ -59,4 +59,4 @@ The reason for locking the issue or pull request conversation. Lock will fail if -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#lock-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#lock-an-issue). diff --git a/docs/issues/removeAllLabels.md b/docs/issues/removeAllLabels.md index fc5c19d04..95654953b 100644 --- a/docs/issues/removeAllLabels.md +++ b/docs/issues/removeAllLabels.md @@ -47,4 +47,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue). diff --git a/docs/issues/removeLabel.md b/docs/issues/removeLabel.md index ff363dbd8..f759ddba3 100644 --- a/docs/issues/removeLabel.md +++ b/docs/issues/removeLabel.md @@ -51,4 +51,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#remove-a-label-from-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue). diff --git a/docs/issues/setLabels.md b/docs/issues/setLabels.md index 5f6092762..d96e01796 100644 --- a/docs/issues/setLabels.md +++ b/docs/issues/setLabels.md @@ -54,4 +54,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#set-labels-for-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue). diff --git a/docs/issues/unlock.md b/docs/issues/unlock.md index 3489e4d2c..b5e62c4a2 100644 --- a/docs/issues/unlock.md +++ b/docs/issues/unlock.md @@ -47,4 +47,4 @@ The number that identifies the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#unlock-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#unlock-an-issue). diff --git a/docs/issues/update.md b/docs/issues/update.md index 8668c3278..817e3b312 100644 --- a/docs/issues/update.md +++ b/docs/issues/update.md @@ -85,4 +85,4 @@ Usernames to assign to this issue. Pass one or more user logins to _replace_ the -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#update-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/issues#update-an-issue). diff --git a/docs/issues/updateComment.md b/docs/issues/updateComment.md index bb9c5b3bd..ca4170d41 100644 --- a/docs/issues/updateComment.md +++ b/docs/issues/updateComment.md @@ -53,4 +53,4 @@ The contents of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#update-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/comments#update-an-issue-comment). diff --git a/docs/issues/updateLabel.md b/docs/issues/updateLabel.md index 82902b31f..74f2f96e4 100644 --- a/docs/issues/updateLabel.md +++ b/docs/issues/updateLabel.md @@ -60,4 +60,4 @@ A short description of the label. Must be 100 characters or fewer. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#update-a-label). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/labels#update-a-label). diff --git a/docs/issues/updateMilestone.md b/docs/issues/updateMilestone.md index 6af5fbdcb..b0f9ceca1 100644 --- a/docs/issues/updateMilestone.md +++ b/docs/issues/updateMilestone.md @@ -65,4 +65,4 @@ The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.o -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/issues#update-a-milestone). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/issues/milestones#update-a-milestone). diff --git a/docs/licenses/get.md b/docs/licenses/get.md index dd866188f..65e74ae8c 100644 --- a/docs/licenses/get.md +++ b/docs/licenses/get.md @@ -8,6 +8,8 @@ type: API method # Get a license +Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + ```js octokit.rest.licenses.get({ license, @@ -31,4 +33,4 @@ octokit.rest.licenses.get({ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/licenses#get-a-license). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/licenses/licenses#get-a-license). diff --git a/docs/licenses/getAllCommonlyUsed.md b/docs/licenses/getAllCommonlyUsed.md index 7049d9084..c616cf1d9 100644 --- a/docs/licenses/getAllCommonlyUsed.md +++ b/docs/licenses/getAllCommonlyUsed.md @@ -8,6 +8,8 @@ type: API method # Get all commonly used licenses +Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + ```js octokit.rest.licenses.getAllCommonlyUsed(); ``` @@ -39,4 +41,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses). diff --git a/docs/licenses/getForRepo.md b/docs/licenses/getForRepo.md index 8d57ba16c..11bddced6 100644 --- a/docs/licenses/getForRepo.md +++ b/docs/licenses/getForRepo.md @@ -10,7 +10,7 @@ type: API method This method returns the contents of the repository's license file, if one is detected. -Similar 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. +Similar to [Get repository content](https://docs.github.com/rest/repos/contents#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. ```js octokit.rest.licenses.getForRepo({ @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/licenses/#get-the-license-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository). diff --git a/docs/markdown/render.md b/docs/markdown/render.md index f32e0c1eb..f2551d998 100644 --- a/docs/markdown/render.md +++ b/docs/markdown/render.md @@ -43,4 +43,4 @@ The repository context to use when creating references in `gfm` mode. For exampl -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/markdown#render-a-markdown-document). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/markdown/markdown#render-a-markdown-document). diff --git a/docs/markdown/renderRaw.md b/docs/markdown/renderRaw.md index d1bc491f4..f2847ce99 100644 --- a/docs/markdown/renderRaw.md +++ b/docs/markdown/renderRaw.md @@ -35,4 +35,4 @@ raw markdown text -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/markdown#render-a-markdown-document-in-raw-mode). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode). diff --git a/docs/meta/get.md b/docs/meta/get.md index 85dedd718..7b27c637a 100644 --- a/docs/meta/get.md +++ b/docs/meta/get.md @@ -24,4 +24,4 @@ octokit.rest.meta.get(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/meta#get-github-meta-information). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta/meta#get-apiname-meta-information). diff --git a/docs/meta/getAllVersions.md b/docs/meta/getAllVersions.md index 21aeda439..c3b67d954 100644 --- a/docs/meta/getAllVersions.md +++ b/docs/meta/getAllVersions.md @@ -18,4 +18,4 @@ octokit.rest.meta.getAllVersions(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/meta#get-all-api-versions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta/meta#get-all-api-versions). diff --git a/docs/meta/getOctocat.md b/docs/meta/getOctocat.md index cee2251cc..8b95e91da 100644 --- a/docs/meta/getOctocat.md +++ b/docs/meta/getOctocat.md @@ -33,4 +33,4 @@ The words to show in Octocat's speech bubble -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/meta#get-octocat). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta/meta#get-octocat). diff --git a/docs/meta/getZen.md b/docs/meta/getZen.md index 7da57c99a..c022a48e8 100644 --- a/docs/meta/getZen.md +++ b/docs/meta/getZen.md @@ -18,4 +18,4 @@ octokit.rest.meta.getZen(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta#get-the-zen-of-github). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta/meta#get-the-zen-of-github). diff --git a/docs/meta/root.md b/docs/meta/root.md index 99b92f539..d15417ed9 100644 --- a/docs/meta/root.md +++ b/docs/meta/root.md @@ -18,4 +18,4 @@ octokit.rest.meta.root(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/overview/resources-in-the-rest-api#root-endpoint). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/meta/meta#github-api-root). diff --git a/docs/orgs/addSecurityManagerTeam.md b/docs/orgs/addSecurityManagerTeam.md index 208a47ea7..ed0dc95c3 100644 --- a/docs/orgs/addSecurityManagerTeam.md +++ b/docs/orgs/addSecurityManagerTeam.md @@ -45,4 +45,4 @@ The slug of the team name. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#add-a-security-manager-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team). diff --git a/docs/orgs/blockUser.md b/docs/orgs/blockUser.md index 38dafed23..58f6495e4 100644 --- a/docs/orgs/blockUser.md +++ b/docs/orgs/blockUser.md @@ -8,6 +8,8 @@ type: API method # Block a user from an organization +Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. + ```js octokit.rest.orgs.blockUser({ org, @@ -39,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization). diff --git a/docs/orgs/cancelInvitation.md b/docs/orgs/cancelInvitation.md index 6e9a2cce4..0607da6ac 100644 --- a/docs/orgs/cancelInvitation.md +++ b/docs/orgs/cancelInvitation.md @@ -43,4 +43,4 @@ The unique identifier of the invitation. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation). diff --git a/docs/orgs/checkBlockedUser.md b/docs/orgs/checkBlockedUser.md index 34afbdb63..c7f62fb87 100644 --- a/docs/orgs/checkBlockedUser.md +++ b/docs/orgs/checkBlockedUser.md @@ -8,6 +8,8 @@ type: API method # Check if a user is blocked by an organization +Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. + ```js octokit.rest.orgs.checkBlockedUser({ org, @@ -39,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization). diff --git a/docs/orgs/checkMembershipForUser.md b/docs/orgs/checkMembershipForUser.md index 928e8584f..9a0454010 100644 --- a/docs/orgs/checkMembershipForUser.md +++ b/docs/orgs/checkMembershipForUser.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#check-organization-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user). diff --git a/docs/orgs/checkPublicMembershipForUser.md b/docs/orgs/checkPublicMembershipForUser.md index 7234ac808..9cc9cb6de 100644 --- a/docs/orgs/checkPublicMembershipForUser.md +++ b/docs/orgs/checkPublicMembershipForUser.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user). diff --git a/docs/orgs/convertMemberToOutsideCollaborator.md b/docs/orgs/convertMemberToOutsideCollaborator.md index f081c012a..fa8bf5cfc 100644 --- a/docs/orgs/convertMemberToOutsideCollaborator.md +++ b/docs/orgs/convertMemberToOutsideCollaborator.md @@ -46,4 +46,4 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator). diff --git a/docs/orgs/createInvitation.md b/docs/orgs/createInvitation.md index 145cbdba9..d6726eccb 100644 --- a/docs/orgs/createInvitation.md +++ b/docs/orgs/createInvitation.md @@ -61,4 +61,4 @@ Specify IDs for the teams you want to invite new members to. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#create-an-organization-invitation). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#create-an-organization-invitation). diff --git a/docs/orgs/createWebhook.md b/docs/orgs/createWebhook.md index d67c8743f..1816bc682 100644 --- a/docs/orgs/createWebhook.md +++ b/docs/orgs/createWebhook.md @@ -42,7 +42,7 @@ Must be passed as "web". configyes -Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params). +Key/value pairs to provide settings for this webhook. config.urlyes @@ -82,4 +82,4 @@ Determines if notifications are sent when the webhook is triggered. Set to `true -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#create-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook). diff --git a/docs/orgs/delete.md b/docs/orgs/delete.md index 1a435067a..ed2f19eac 100644 --- a/docs/orgs/delete.md +++ b/docs/orgs/delete.md @@ -41,4 +41,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs/#delete-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#delete-an-organization). diff --git a/docs/orgs/deleteWebhook.md b/docs/orgs/deleteWebhook.md index 163aa6a28..5f9be7584 100644 --- a/docs/orgs/deleteWebhook.md +++ b/docs/orgs/deleteWebhook.md @@ -39,4 +39,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook). diff --git a/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md b/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md index a4424bef1..3aa270d9d 100644 --- a/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md +++ b/docs/orgs/enableOrDisableSecurityProductOnAllOrgRepos.md @@ -53,8 +53,14 @@ The action to take. `enable_all` means to enable the specified security feature for all repositories in the organization. `disable_all` means to disable the specified security feature for all repositories in the organization. + +query_suiteno + +CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. +If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization). diff --git a/docs/orgs/get.md b/docs/orgs/get.md index 1009c4bef..0e452ddae 100644 --- a/docs/orgs/get.md +++ b/docs/orgs/get.md @@ -37,4 +37,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#get-an-organization). diff --git a/docs/orgs/getMembershipForAuthenticatedUser.md b/docs/orgs/getMembershipForAuthenticatedUser.md index fe361535a..a0bcdc11e 100644 --- a/docs/orgs/getMembershipForAuthenticatedUser.md +++ b/docs/orgs/getMembershipForAuthenticatedUser.md @@ -35,4 +35,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user). diff --git a/docs/orgs/getMembershipForUser.md b/docs/orgs/getMembershipForUser.md index 29b946886..3d3cc9bd5 100644 --- a/docs/orgs/getMembershipForUser.md +++ b/docs/orgs/getMembershipForUser.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user). diff --git a/docs/orgs/getWebhook.md b/docs/orgs/getWebhook.md index 33c3b76b5..bdb7d469d 100644 --- a/docs/orgs/getWebhook.md +++ b/docs/orgs/getWebhook.md @@ -8,7 +8,7 @@ type: API method # Get an organization webhook -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)." +Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." ```js octokit.rest.orgs.getWebhook({ @@ -41,4 +41,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook). diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md index 0dd48e9a1..859fd4870 100644 --- a/docs/orgs/getWebhookConfigForOrg.md +++ b/docs/orgs/getWebhookConfigForOrg.md @@ -8,7 +8,7 @@ type: API method # Get a webhook configuration for an organization -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)." +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/orgs/webhooks#get-an-organization-webhook)." Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. @@ -43,4 +43,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-a-webhook-configuration-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). diff --git a/docs/orgs/getWebhookDelivery.md b/docs/orgs/getWebhookDelivery.md index 0f954820c..c04a69cfe 100644 --- a/docs/orgs/getWebhookDelivery.md +++ b/docs/orgs/getWebhookDelivery.md @@ -45,4 +45,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook). diff --git a/docs/orgs/list.md b/docs/orgs/list.md index e4e99e3af..a7aab6d21 100644 --- a/docs/orgs/list.md +++ b/docs/orgs/list.md @@ -40,4 +40,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organizations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-organizations). diff --git a/docs/orgs/listAppInstallations.md b/docs/orgs/listAppInstallations.md index c3015d8e7..6367a725f 100644 --- a/docs/orgs/listAppInstallations.md +++ b/docs/orgs/listAppInstallations.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-app-installations-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization). diff --git a/docs/orgs/listBlockedUsers.md b/docs/orgs/listBlockedUsers.md index 3507d0ae8..714bb81f4 100644 --- a/docs/orgs/listBlockedUsers.md +++ b/docs/orgs/listBlockedUsers.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-users-blocked-by-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization). diff --git a/docs/orgs/listFailedInvitations.md b/docs/orgs/listFailedInvitations.md index 70f38b834..f7836bb7e 100644 --- a/docs/orgs/listFailedInvitations.md +++ b/docs/orgs/listFailedInvitations.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-failed-organization-invitations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-failed-organization-invitations). diff --git a/docs/orgs/listForAuthenticatedUser.md b/docs/orgs/listForAuthenticatedUser.md index e79504825..e3685044a 100644 --- a/docs/orgs/listForAuthenticatedUser.md +++ b/docs/orgs/listForAuthenticatedUser.md @@ -42,4 +42,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user). diff --git a/docs/orgs/listForUser.md b/docs/orgs/listForUser.md index 038eb1aa2..48e22d8e9 100644 --- a/docs/orgs/listForUser.md +++ b/docs/orgs/listForUser.md @@ -10,7 +10,7 @@ type: API method List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. -This 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. +This 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/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. ```js octokit.rest.orgs.listForUser({ @@ -47,4 +47,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organizations-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user). diff --git a/docs/orgs/listInvitationTeams.md b/docs/orgs/listInvitationTeams.md index e6238734c..e59524a69 100644 --- a/docs/orgs/listInvitationTeams.md +++ b/docs/orgs/listInvitationTeams.md @@ -51,4 +51,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organization-invitation-teams). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-organization-invitation-teams). diff --git a/docs/orgs/listMembers.md b/docs/orgs/listMembers.md index 5068525c5..f562647f7 100644 --- a/docs/orgs/listMembers.md +++ b/docs/orgs/listMembers.md @@ -55,4 +55,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organization-members). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-organization-members). diff --git a/docs/orgs/listMembershipsForAuthenticatedUser.md b/docs/orgs/listMembershipsForAuthenticatedUser.md index 1f62644ff..1d0490f0e 100644 --- a/docs/orgs/listMembershipsForAuthenticatedUser.md +++ b/docs/orgs/listMembershipsForAuthenticatedUser.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user). diff --git a/docs/orgs/listOutsideCollaborators.md b/docs/orgs/listOutsideCollaborators.md index a047017cb..b7aee7752 100644 --- a/docs/orgs/listOutsideCollaborators.md +++ b/docs/orgs/listOutsideCollaborators.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-outside-collaborators-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization). diff --git a/docs/orgs/listPatGrantRepositories.md b/docs/orgs/listPatGrantRepositories.md index 25387d35d..a131d26b4 100644 --- a/docs/orgs/listPatGrantRepositories.md +++ b/docs/orgs/listPatGrantRepositories.md @@ -1,7 +1,7 @@ --- name: List repositories a fine-grained personal access token has access to example: octokit.rest.orgs.listPatGrantRepositories({ org, pat_id }) -route: GET /organizations/{org}/personal-access-tokens/{pat_id}/repositories +route: GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories scope: orgs type: API method --- @@ -54,4 +54,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to). diff --git a/docs/orgs/listPatGrantRequestRepositories.md b/docs/orgs/listPatGrantRequestRepositories.md index badc9385f..f928723f6 100644 --- a/docs/orgs/listPatGrantRequestRepositories.md +++ b/docs/orgs/listPatGrantRequestRepositories.md @@ -1,7 +1,7 @@ --- name: List repositories requested to be accessed by a fine-grained personal access token example: octokit.rest.orgs.listPatGrantRequestRepositories({ org, pat_request_id }) -route: GET /organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories +route: GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories scope: orgs type: API method --- @@ -54,4 +54,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token). diff --git a/docs/orgs/listPatGrantRequests.md b/docs/orgs/listPatGrantRequests.md index 33b243be4..6c0ce282f 100644 --- a/docs/orgs/listPatGrantRequests.md +++ b/docs/orgs/listPatGrantRequests.md @@ -1,7 +1,7 @@ --- name: List requests to access organization resources with fine-grained personal access tokens example: octokit.rest.orgs.listPatGrantRequests({ org }) -route: GET /organizations/{org}/personal-access-token-requests +route: GET /orgs/{org}/personal-access-token-requests scope: orgs type: API method --- @@ -83,4 +83,4 @@ Only show fine-grained personal access tokens used after the given time. This is -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens). diff --git a/docs/orgs/listPatGrants.md b/docs/orgs/listPatGrants.md index d67b07189..60c5d4c8d 100644 --- a/docs/orgs/listPatGrants.md +++ b/docs/orgs/listPatGrants.md @@ -1,7 +1,7 @@ --- name: List fine-grained personal access tokens with access to organization resources example: octokit.rest.orgs.listPatGrants({ org }) -route: GET /organizations/{org}/personal-access-tokens +route: GET /orgs/{org}/personal-access-tokens scope: orgs type: API method --- @@ -83,4 +83,4 @@ Only show fine-grained personal access tokens used after the given time. This is -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources). diff --git a/docs/orgs/listPendingInvitations.md b/docs/orgs/listPendingInvitations.md index db4dc1fc6..9c6f66252 100644 --- a/docs/orgs/listPendingInvitations.md +++ b/docs/orgs/listPendingInvitations.md @@ -55,4 +55,4 @@ Filter invitations by their invitation source. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-pending-organization-invitations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-pending-organization-invitations). diff --git a/docs/orgs/listPublicMembers.md b/docs/orgs/listPublicMembers.md index ec24c81f7..7db234a36 100644 --- a/docs/orgs/listPublicMembers.md +++ b/docs/orgs/listPublicMembers.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-public-organization-members). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#list-public-organization-members). diff --git a/docs/orgs/listSecurityManagerTeams.md b/docs/orgs/listSecurityManagerTeams.md index 91161e73b..a802f4e4d 100644 --- a/docs/orgs/listSecurityManagerTeams.md +++ b/docs/orgs/listSecurityManagerTeams.md @@ -39,4 +39,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-security-manager-teams). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams). diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md index 09e527f6d..217f7ac22 100644 --- a/docs/orgs/listWebhookDeliveries.md +++ b/docs/orgs/listWebhookDeliveries.md @@ -54,4 +54,4 @@ Used for pagination: the starting delivery from which the page of deliveries is -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-deliveries-for-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook). diff --git a/docs/orgs/listWebhooks.md b/docs/orgs/listWebhooks.md index 9e62dd517..d705e5114 100644 --- a/docs/orgs/listWebhooks.md +++ b/docs/orgs/listWebhooks.md @@ -43,4 +43,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#list-organization-webhooks). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks). diff --git a/docs/orgs/pingWebhook.md b/docs/orgs/pingWebhook.md index cef7ca9b6..7794d63ec 100644 --- a/docs/orgs/pingWebhook.md +++ b/docs/orgs/pingWebhook.md @@ -41,4 +41,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#ping-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook). diff --git a/docs/orgs/redeliverWebhookDelivery.md b/docs/orgs/redeliverWebhookDelivery.md index 2ec8d7fcf..69b410810 100644 --- a/docs/orgs/redeliverWebhookDelivery.md +++ b/docs/orgs/redeliverWebhookDelivery.md @@ -45,4 +45,4 @@ The unique identifier of the hook. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook). diff --git a/docs/orgs/removeMember.md b/docs/orgs/removeMember.md index 4543b9ef2..a5c006666 100644 --- a/docs/orgs/removeMember.md +++ b/docs/orgs/removeMember.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#remove-an-organization-member). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#remove-an-organization-member). diff --git a/docs/orgs/removeMembershipForUser.md b/docs/orgs/removeMembershipForUser.md index fb66495e5..aaed01dbe 100644 --- a/docs/orgs/removeMembershipForUser.md +++ b/docs/orgs/removeMembershipForUser.md @@ -43,4 +43,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#remove-organization-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user). diff --git a/docs/orgs/removeOutsideCollaborator.md b/docs/orgs/removeOutsideCollaborator.md index 4ee65fd4f..ab0673a8d 100644 --- a/docs/orgs/removeOutsideCollaborator.md +++ b/docs/orgs/removeOutsideCollaborator.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#remove-outside-collaborator-from-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization). diff --git a/docs/orgs/removePublicMembershipForAuthenticatedUser.md b/docs/orgs/removePublicMembershipForAuthenticatedUser.md index b586a1e26..79dd5baa8 100644 --- a/docs/orgs/removePublicMembershipForAuthenticatedUser.md +++ b/docs/orgs/removePublicMembershipForAuthenticatedUser.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user). diff --git a/docs/orgs/removeSecurityManagerTeam.md b/docs/orgs/removeSecurityManagerTeam.md index 13ddb7e3a..9e81f55fa 100644 --- a/docs/orgs/removeSecurityManagerTeam.md +++ b/docs/orgs/removeSecurityManagerTeam.md @@ -45,4 +45,4 @@ The slug of the team name. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#remove-a-security-manager-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team). diff --git a/docs/orgs/reviewPatGrantRequest.md b/docs/orgs/reviewPatGrantRequest.md index fed3613ad..9ed2b88d4 100644 --- a/docs/orgs/reviewPatGrantRequest.md +++ b/docs/orgs/reviewPatGrantRequest.md @@ -1,7 +1,7 @@ --- name: Review a request to access organization resources with a fine-grained personal access token example: octokit.rest.orgs.reviewPatGrantRequest({ org, pat_request_id, action }) -route: POST /organizations/{org}/personal-access-token-requests/{pat_request_id} +route: POST /orgs/{org}/personal-access-token-requests/{pat_request_id} scope: orgs type: API method --- @@ -55,4 +55,4 @@ Reason for approving or denying the request. Max 1024 characters. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token). diff --git a/docs/orgs/reviewPatGrantRequestsInBulk.md b/docs/orgs/reviewPatGrantRequestsInBulk.md index 5261cc4b5..5c45846f7 100644 --- a/docs/orgs/reviewPatGrantRequestsInBulk.md +++ b/docs/orgs/reviewPatGrantRequestsInBulk.md @@ -1,7 +1,7 @@ --- name: Review requests to access organization resources with fine-grained personal access tokens example: octokit.rest.orgs.reviewPatGrantRequestsInBulk({ org, action }) -route: POST /organizations/{org}/personal-access-token-requests +route: POST /orgs/{org}/personal-access-token-requests scope: orgs type: API method --- @@ -54,4 +54,4 @@ Reason for approving or denying the requests. Max 1024 characters. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens). diff --git a/docs/orgs/setMembershipForUser.md b/docs/orgs/setMembershipForUser.md index b4a758210..af6906eee 100644 --- a/docs/orgs/setMembershipForUser.md +++ b/docs/orgs/setMembershipForUser.md @@ -10,7 +10,7 @@ type: API method Only authenticated organization owners can add a member to the organization or update the member's role. -- 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. +- 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/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - 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. **Rate limits** @@ -56,4 +56,4 @@ The role to give the user in the organization. Can be one of: -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#set-organization-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user). diff --git a/docs/orgs/setPublicMembershipForAuthenticatedUser.md b/docs/orgs/setPublicMembershipForAuthenticatedUser.md index 35fa342df..a45ddd1a1 100644 --- a/docs/orgs/setPublicMembershipForAuthenticatedUser.md +++ b/docs/orgs/setPublicMembershipForAuthenticatedUser.md @@ -43,4 +43,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user). diff --git a/docs/orgs/unblockUser.md b/docs/orgs/unblockUser.md index a88ba56d0..fa4d6c892 100644 --- a/docs/orgs/unblockUser.md +++ b/docs/orgs/unblockUser.md @@ -8,6 +8,8 @@ type: API method # Unblock a user from an organization +Unblocks the given user on behalf of the specified organization. + ```js octokit.rest.orgs.unblockUser({ org, @@ -39,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization). diff --git a/docs/orgs/update.md b/docs/orgs/update.md index 7dd395bee..65f2789c3 100644 --- a/docs/orgs/update.md +++ b/docs/orgs/update.md @@ -205,4 +205,4 @@ If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that w -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#update-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#update-an-organization). diff --git a/docs/orgs/updateMembershipForAuthenticatedUser.md b/docs/orgs/updateMembershipForAuthenticatedUser.md index b5976c17e..1fcd42452 100644 --- a/docs/orgs/updateMembershipForAuthenticatedUser.md +++ b/docs/orgs/updateMembershipForAuthenticatedUser.md @@ -41,4 +41,4 @@ The state that the membership should be in. Only `"active"` will be accepted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user). diff --git a/docs/orgs/updatePatAccess.md b/docs/orgs/updatePatAccess.md index d364af79d..972816c06 100644 --- a/docs/orgs/updatePatAccess.md +++ b/docs/orgs/updatePatAccess.md @@ -1,7 +1,7 @@ --- name: Update the access a fine-grained personal access token has to organization resources example: octokit.rest.orgs.updatePatAccess({ org, pat_id, action }) -route: POST /organizations/{org}/personal-access-tokens/{pat_id} +route: POST /orgs/{org}/personal-access-tokens/{pat_id} scope: orgs type: API method --- @@ -50,4 +50,4 @@ Action to apply to the fine-grained personal access token. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources). diff --git a/docs/orgs/updatePatAccesses.md b/docs/orgs/updatePatAccesses.md index 060f9ebfe..e5d9a0419 100644 --- a/docs/orgs/updatePatAccesses.md +++ b/docs/orgs/updatePatAccesses.md @@ -1,7 +1,7 @@ --- name: Update the access to organization resources via fine-grained personal access tokens example: octokit.rest.orgs.updatePatAccesses({ org, action, pat_ids }) -route: POST /organizations/{org}/personal-access-tokens +route: POST /orgs/{org}/personal-access-tokens scope: orgs type: API method --- @@ -50,4 +50,4 @@ The IDs of the fine-grained personal access tokens. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens). diff --git a/docs/orgs/updateWebhook.md b/docs/orgs/updateWebhook.md index e2a307e21..6b966400c 100644 --- a/docs/orgs/updateWebhook.md +++ b/docs/orgs/updateWebhook.md @@ -8,7 +8,7 @@ type: API method # Update an organization webhook -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)." +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/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." ```js octokit.rest.orgs.updateWebhook({ @@ -41,7 +41,7 @@ The unique identifier of the hook. configno -Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params). +Key/value pairs to provide settings for this webhook. config.urlyes @@ -78,4 +78,4 @@ Determines if notifications are sent when the webhook is triggered. Set to `true -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#update-an-organization-webhook). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook). diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md index 8105f21d7..ad8099f72 100644 --- a/docs/orgs/updateWebhookConfigForOrg.md +++ b/docs/orgs/updateWebhookConfigForOrg.md @@ -8,7 +8,7 @@ type: API method # Update a webhook configuration for an organization -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)." +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/orgs/webhooks#update-an-organization-webhook)." Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. @@ -61,4 +61,4 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/orgs#update-a-webhook-configuration-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization). diff --git a/docs/packages/deletePackageForAuthenticatedUser.md b/docs/packages/deletePackageForAuthenticatedUser.md index 7447e3a49..30510d853 100644 --- a/docs/packages/deletePackageForAuthenticatedUser.md +++ b/docs/packages/deletePackageForAuthenticatedUser.md @@ -44,4 +44,4 @@ The name of the package. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user). diff --git a/docs/packages/deletePackageForOrg.md b/docs/packages/deletePackageForOrg.md index 70e46e52c..bc89bf64c 100644 --- a/docs/packages/deletePackageForOrg.md +++ b/docs/packages/deletePackageForOrg.md @@ -52,4 +52,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization). diff --git a/docs/packages/deletePackageForUser.md b/docs/packages/deletePackageForUser.md index e7cea20fb..15cbfddf5 100644 --- a/docs/packages/deletePackageForUser.md +++ b/docs/packages/deletePackageForUser.md @@ -52,4 +52,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user). diff --git a/docs/packages/deletePackageVersionForAuthenticatedUser.md b/docs/packages/deletePackageVersionForAuthenticatedUser.md index 176f4f227..65f814b7d 100644 --- a/docs/packages/deletePackageVersionForAuthenticatedUser.md +++ b/docs/packages/deletePackageVersionForAuthenticatedUser.md @@ -50,4 +50,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user). diff --git a/docs/packages/deletePackageVersionForOrg.md b/docs/packages/deletePackageVersionForOrg.md index b918d5448..3d7dfebbc 100644 --- a/docs/packages/deletePackageVersionForOrg.md +++ b/docs/packages/deletePackageVersionForOrg.md @@ -58,4 +58,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization). diff --git a/docs/packages/deletePackageVersionForUser.md b/docs/packages/deletePackageVersionForUser.md index 40d698f86..d2f0e461e 100644 --- a/docs/packages/deletePackageVersionForUser.md +++ b/docs/packages/deletePackageVersionForUser.md @@ -58,4 +58,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user). diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md index 085877b28..5d3e09145 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByAnOrg.md @@ -66,4 +66,4 @@ The state of the package, either active or deleted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization). diff --git a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md index e74a79d43..6d2a9c4fc 100644 --- a/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser.md @@ -62,4 +62,4 @@ The state of the package, either active or deleted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user). diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md index 2ab2811e3..56fbc21cd 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByAuthenticatedUser.md @@ -58,4 +58,4 @@ The state of the package, either active or deleted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user). diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md index 33b24e013..f97518735 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByOrg.md @@ -64,4 +64,4 @@ The state of the package, either active or deleted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization). diff --git a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md index 6ebe64a44..0bcab0809 100644 --- a/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md +++ b/docs/packages/getAllPackageVersionsForPackageOwnedByUser.md @@ -49,4 +49,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user). diff --git a/docs/packages/getPackageForAuthenticatedUser.md b/docs/packages/getPackageForAuthenticatedUser.md index 15923fc27..2fc10465b 100644 --- a/docs/packages/getPackageForAuthenticatedUser.md +++ b/docs/packages/getPackageForAuthenticatedUser.md @@ -43,4 +43,4 @@ The name of the package. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user). diff --git a/docs/packages/getPackageForOrganization.md b/docs/packages/getPackageForOrganization.md index f1f73ab07..d00b64795 100644 --- a/docs/packages/getPackageForOrganization.md +++ b/docs/packages/getPackageForOrganization.md @@ -49,4 +49,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization). diff --git a/docs/packages/getPackageForUser.md b/docs/packages/getPackageForUser.md index c62c42bc0..7ed90a60e 100644 --- a/docs/packages/getPackageForUser.md +++ b/docs/packages/getPackageForUser.md @@ -49,4 +49,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-for-a-user). diff --git a/docs/packages/getPackageVersionForAuthenticatedUser.md b/docs/packages/getPackageVersionForAuthenticatedUser.md index 92474d7da..94ff969b6 100644 --- a/docs/packages/getPackageVersionForAuthenticatedUser.md +++ b/docs/packages/getPackageVersionForAuthenticatedUser.md @@ -49,4 +49,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user). diff --git a/docs/packages/getPackageVersionForOrganization.md b/docs/packages/getPackageVersionForOrganization.md index fed8dfd3a..779cf59cf 100644 --- a/docs/packages/getPackageVersionForOrganization.md +++ b/docs/packages/getPackageVersionForOrganization.md @@ -55,4 +55,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization). diff --git a/docs/packages/getPackageVersionForUser.md b/docs/packages/getPackageVersionForUser.md index ea060f310..3ca48425c 100644 --- a/docs/packages/getPackageVersionForUser.md +++ b/docs/packages/getPackageVersionForUser.md @@ -55,4 +55,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user). diff --git a/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md b/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md index 303cf73d1..0999a1361 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForAuthenticatedUser.md @@ -19,4 +19,4 @@ octokit.rest.packages.listDockerMigrationConflictingPackagesForAuthenticatedUser This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages#list-docker-migration-conflicting-packages-for-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user). diff --git a/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md b/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md index 89cedd92a..11c4d3092 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForOrganization.md @@ -36,4 +36,4 @@ The organization name. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization). diff --git a/docs/packages/listDockerMigrationConflictingPackagesForUser.md b/docs/packages/listDockerMigrationConflictingPackagesForUser.md index 6a8dcc523..e7beb345a 100644 --- a/docs/packages/listDockerMigrationConflictingPackagesForUser.md +++ b/docs/packages/listDockerMigrationConflictingPackagesForUser.md @@ -36,4 +36,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user). diff --git a/docs/packages/listPackagesForAuthenticatedUser.md b/docs/packages/listPackagesForAuthenticatedUser.md index 97a41e04c..799e95347 100644 --- a/docs/packages/listPackagesForAuthenticatedUser.md +++ b/docs/packages/listPackagesForAuthenticatedUser.md @@ -55,4 +55,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace). diff --git a/docs/packages/listPackagesForOrganization.md b/docs/packages/listPackagesForOrganization.md index 849dda603..20235654e 100644 --- a/docs/packages/listPackagesForOrganization.md +++ b/docs/packages/listPackagesForOrganization.md @@ -61,4 +61,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-packages-for-an-organization). diff --git a/docs/packages/listPackagesForUser.md b/docs/packages/listPackagesForUser.md index 7c31fdb8c..aaba1645c 100644 --- a/docs/packages/listPackagesForUser.md +++ b/docs/packages/listPackagesForUser.md @@ -61,4 +61,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#list-packages-for-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#list-packages-for-a-user). diff --git a/docs/packages/restorePackageForAuthenticatedUser.md b/docs/packages/restorePackageForAuthenticatedUser.md index a233863a7..9f5defadb 100644 --- a/docs/packages/restorePackageForAuthenticatedUser.md +++ b/docs/packages/restorePackageForAuthenticatedUser.md @@ -53,4 +53,4 @@ package token -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user). diff --git a/docs/packages/restorePackageForOrg.md b/docs/packages/restorePackageForOrg.md index d883c4f75..7d7547f89 100644 --- a/docs/packages/restorePackageForOrg.md +++ b/docs/packages/restorePackageForOrg.md @@ -62,4 +62,4 @@ package token -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization). diff --git a/docs/packages/restorePackageForUser.md b/docs/packages/restorePackageForUser.md index 40d2f966a..0f6ec1b91 100644 --- a/docs/packages/restorePackageForUser.md +++ b/docs/packages/restorePackageForUser.md @@ -62,4 +62,4 @@ package token -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user). diff --git a/docs/packages/restorePackageVersionForAuthenticatedUser.md b/docs/packages/restorePackageVersionForAuthenticatedUser.md index bc464408a..c2f730769 100644 --- a/docs/packages/restorePackageVersionForAuthenticatedUser.md +++ b/docs/packages/restorePackageVersionForAuthenticatedUser.md @@ -54,4 +54,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user). diff --git a/docs/packages/restorePackageVersionForOrg.md b/docs/packages/restorePackageVersionForOrg.md index f4ee88b7e..74779b313 100644 --- a/docs/packages/restorePackageVersionForOrg.md +++ b/docs/packages/restorePackageVersionForOrg.md @@ -63,4 +63,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization). diff --git a/docs/packages/restorePackageVersionForUser.md b/docs/packages/restorePackageVersionForUser.md index 2b10d5e0c..7572bdc05 100644 --- a/docs/packages/restorePackageVersionForUser.md +++ b/docs/packages/restorePackageVersionForUser.md @@ -63,4 +63,4 @@ Unique identifier of the package version. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user). diff --git a/docs/projects/addCollaborator.md b/docs/projects/addCollaborator.md index 94fd87c9d..294c67fa6 100644 --- a/docs/projects/addCollaborator.md +++ b/docs/projects/addCollaborator.md @@ -46,4 +46,4 @@ The permission to grant the collaborator. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#add-project-collaborator). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/collaborators#add-project-collaborator). diff --git a/docs/projects/createCard.md b/docs/projects/createCard.md index 5f488324f..0618e7118 100644 --- a/docs/projects/createCard.md +++ b/docs/projects/createCard.md @@ -51,4 +51,4 @@ The piece of content associated with the card -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#create-a-project-card). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#create-a-project-card). diff --git a/docs/projects/createColumn.md b/docs/projects/createColumn.md index b47c7e700..11938495f 100644 --- a/docs/projects/createColumn.md +++ b/docs/projects/createColumn.md @@ -41,4 +41,4 @@ Name of the project column -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#create-a-project-column). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#create-a-project-column). diff --git a/docs/projects/createForAuthenticatedUser.md b/docs/projects/createForAuthenticatedUser.md index 817dd5862..cd3573ca5 100644 --- a/docs/projects/createForAuthenticatedUser.md +++ b/docs/projects/createForAuthenticatedUser.md @@ -40,4 +40,4 @@ Body of the project -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#create-a-user-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#create-a-user-project). diff --git a/docs/projects/createForOrg.md b/docs/projects/createForOrg.md index 04edcab43..ea53d3e9d 100644 --- a/docs/projects/createForOrg.md +++ b/docs/projects/createForOrg.md @@ -46,4 +46,4 @@ The description of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#create-an-organization-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#create-an-organization-project). diff --git a/docs/projects/createForRepo.md b/docs/projects/createForRepo.md index e37914ef1..c21015f48 100644 --- a/docs/projects/createForRepo.md +++ b/docs/projects/createForRepo.md @@ -52,4 +52,4 @@ The description of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#create-a-repository-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#create-a-repository-project). diff --git a/docs/projects/delete.md b/docs/projects/delete.md index ad472ba2b..c29eb79b4 100644 --- a/docs/projects/delete.md +++ b/docs/projects/delete.md @@ -35,4 +35,4 @@ The unique identifier of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#delete-a-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#delete-a-project). diff --git a/docs/projects/deleteCard.md b/docs/projects/deleteCard.md index eccbd22e2..6f303f5b5 100644 --- a/docs/projects/deleteCard.md +++ b/docs/projects/deleteCard.md @@ -35,4 +35,4 @@ The unique identifier of the card. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#delete-a-project-card). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#delete-a-project-card). diff --git a/docs/projects/deleteColumn.md b/docs/projects/deleteColumn.md index 222a8e209..e91856e76 100644 --- a/docs/projects/deleteColumn.md +++ b/docs/projects/deleteColumn.md @@ -35,4 +35,4 @@ The unique identifier of the column. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#delete-a-project-column). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#delete-a-project-column). diff --git a/docs/projects/get.md b/docs/projects/get.md index d1db3fd88..746ebce72 100644 --- a/docs/projects/get.md +++ b/docs/projects/get.md @@ -35,4 +35,4 @@ The unique identifier of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#get-a-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#get-a-project). diff --git a/docs/projects/getCard.md b/docs/projects/getCard.md index b9d888756..358cabf76 100644 --- a/docs/projects/getCard.md +++ b/docs/projects/getCard.md @@ -35,4 +35,4 @@ The unique identifier of the card. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#get-a-project-card). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#get-a-project-card). diff --git a/docs/projects/getColumn.md b/docs/projects/getColumn.md index 85b466654..efccc1da8 100644 --- a/docs/projects/getColumn.md +++ b/docs/projects/getColumn.md @@ -35,4 +35,4 @@ The unique identifier of the column. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#get-a-project-column). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#get-a-project-column). diff --git a/docs/projects/getPermissionForUser.md b/docs/projects/getPermissionForUser.md index 7dfc90773..7e2367065 100644 --- a/docs/projects/getPermissionForUser.md +++ b/docs/projects/getPermissionForUser.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#get-project-permission-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user). diff --git a/docs/projects/listCards.md b/docs/projects/listCards.md index 60b81b7e7..d2e4a9067 100644 --- a/docs/projects/listCards.md +++ b/docs/projects/listCards.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-project-cards). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#list-project-cards). diff --git a/docs/projects/listCollaborators.md b/docs/projects/listCollaborators.md index f6bab62e2..60e254221 100644 --- a/docs/projects/listCollaborators.md +++ b/docs/projects/listCollaborators.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-project-collaborators). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/collaborators#list-project-collaborators). diff --git a/docs/projects/listColumns.md b/docs/projects/listColumns.md index acd2178ec..4ef2c7722 100644 --- a/docs/projects/listColumns.md +++ b/docs/projects/listColumns.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-project-columns). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#list-project-columns). diff --git a/docs/projects/listForOrg.md b/docs/projects/listForOrg.md index aa6341ec6..faf5a9c05 100644 --- a/docs/projects/listForOrg.md +++ b/docs/projects/listForOrg.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-organization-projects). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#list-organization-projects). diff --git a/docs/projects/listForRepo.md b/docs/projects/listForRepo.md index 415a1f40a..fabc30000 100644 --- a/docs/projects/listForRepo.md +++ b/docs/projects/listForRepo.md @@ -56,4 +56,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-repository-projects). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#list-repository-projects). diff --git a/docs/projects/listForUser.md b/docs/projects/listForUser.md index 99382a6e6..24eb3707e 100644 --- a/docs/projects/listForUser.md +++ b/docs/projects/listForUser.md @@ -50,4 +50,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#list-user-projects). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#list-user-projects). diff --git a/docs/projects/moveCard.md b/docs/projects/moveCard.md index f4fdceb8c..be0fb0b78 100644 --- a/docs/projects/moveCard.md +++ b/docs/projects/moveCard.md @@ -44,4 +44,4 @@ The unique identifier of the column the card should be moved to -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#move-a-project-card). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#move-a-project-card). diff --git a/docs/projects/moveColumn.md b/docs/projects/moveColumn.md index 598f083cc..48441bd34 100644 --- a/docs/projects/moveColumn.md +++ b/docs/projects/moveColumn.md @@ -39,4 +39,4 @@ The position of the column in a project. Can be one of: `first`, `last`, or `aft -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#move-a-project-column). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#move-a-project-column). diff --git a/docs/projects/removeCollaborator.md b/docs/projects/removeCollaborator.md index 72224648e..1062cd5e9 100644 --- a/docs/projects/removeCollaborator.md +++ b/docs/projects/removeCollaborator.md @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#remove-project-collaborator). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator). diff --git a/docs/projects/update.md b/docs/projects/update.md index 4d5b85e56..ef0e4dd05 100644 --- a/docs/projects/update.md +++ b/docs/projects/update.md @@ -60,4 +60,4 @@ Whether or not this project can be seen by everyone. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#update-a-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/projects#update-a-project). diff --git a/docs/projects/updateCard.md b/docs/projects/updateCard.md index 853736068..dbd454bcb 100644 --- a/docs/projects/updateCard.md +++ b/docs/projects/updateCard.md @@ -43,4 +43,4 @@ Whether or not the card is archived -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#update-a-project-card). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/cards#update-an-existing-project-card). diff --git a/docs/projects/updateColumn.md b/docs/projects/updateColumn.md index 240589974..e0ed5918a 100644 --- a/docs/projects/updateColumn.md +++ b/docs/projects/updateColumn.md @@ -39,4 +39,4 @@ Name of the project column -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/projects#update-a-project-column). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/projects/columns#update-an-existing-project-column). diff --git a/docs/pulls/checkIfMerged.md b/docs/pulls/checkIfMerged.md index 57c4bea86..1b3f6ae2c 100644 --- a/docs/pulls/checkIfMerged.md +++ b/docs/pulls/checkIfMerged.md @@ -47,4 +47,4 @@ The number that identifies the pull request. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged). diff --git a/docs/pulls/create.md b/docs/pulls/create.md index 5a81badc5..f8514c510 100644 --- a/docs/pulls/create.md +++ b/docs/pulls/create.md @@ -87,4 +87,4 @@ An issue in the repository to convert to a pull request. The issue title, body, -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#create-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#create-a-pull-request). diff --git a/docs/pulls/createReplyForReviewComment.md b/docs/pulls/createReplyForReviewComment.md index a5ac7b687..f6215eea8 100644 --- a/docs/pulls/createReplyForReviewComment.md +++ b/docs/pulls/createReplyForReviewComment.md @@ -61,4 +61,4 @@ The text of the review comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment). diff --git a/docs/pulls/createReview.md b/docs/pulls/createReview.md index 5561fa776..f5466e61f 100644 --- a/docs/pulls/createReview.md +++ b/docs/pulls/createReview.md @@ -10,9 +10,9 @@ type: API method 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. -Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." +Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." -**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 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. +**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 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/pulls/pulls#get-a-pull-request) endpoint. 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. @@ -64,7 +64,7 @@ The SHA of the commit that needs a review. Not using the latest commit SHA may r eventno -The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready. +The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. commentsno @@ -102,4 +102,4 @@ Text of the review comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request). diff --git a/docs/pulls/createReviewComment.md b/docs/pulls/createReviewComment.md index 69bfafe35..28f242406 100644 --- a/docs/pulls/createReviewComment.md +++ b/docs/pulls/createReviewComment.md @@ -8,7 +8,7 @@ type: API method # Create a review comment for a pull request -Creates 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. +Creates 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/issues/comments#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. The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. @@ -106,4 +106,4 @@ The level at which the comment is targeted. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request). diff --git a/docs/pulls/deletePendingReview.md b/docs/pulls/deletePendingReview.md index 7e3f5ff51..842b54998 100644 --- a/docs/pulls/deletePendingReview.md +++ b/docs/pulls/deletePendingReview.md @@ -53,4 +53,4 @@ The unique identifier of the review. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request). diff --git a/docs/pulls/deleteReviewComment.md b/docs/pulls/deleteReviewComment.md index e773572f7..b24c38c41 100644 --- a/docs/pulls/deleteReviewComment.md +++ b/docs/pulls/deleteReviewComment.md @@ -47,4 +47,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#delete-a-review-comment-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request). diff --git a/docs/pulls/dismissReview.md b/docs/pulls/dismissReview.md index 158ee67df..1c102bdee 100644 --- a/docs/pulls/dismissReview.md +++ b/docs/pulls/dismissReview.md @@ -8,7 +8,7 @@ type: API method # Dismiss a review for a pull request -**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. +**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. ```js octokit.rest.pulls.dismissReview({ @@ -62,4 +62,4 @@ The message for the pull request review dismissal -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#dismiss-a-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request). diff --git a/docs/pulls/get.md b/docs/pulls/get.md index 630526532..3d119e31c 100644 --- a/docs/pulls/get.md +++ b/docs/pulls/get.md @@ -12,7 +12,7 @@ Draft pull requests are available in public repositories with GitHub Free and Gi Lists details of a pull request by providing its number. -When 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)". +When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/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)". The 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. @@ -61,4 +61,4 @@ The number that identifies the pull request. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#get-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#get-a-pull-request). diff --git a/docs/pulls/getReview.md b/docs/pulls/getReview.md index ba77a354c..b1e286905 100644 --- a/docs/pulls/getReview.md +++ b/docs/pulls/getReview.md @@ -53,4 +53,4 @@ The unique identifier of the review. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request). diff --git a/docs/pulls/getReviewComment.md b/docs/pulls/getReviewComment.md index 9f4181dc2..0dae54994 100644 --- a/docs/pulls/getReviewComment.md +++ b/docs/pulls/getReviewComment.md @@ -47,4 +47,4 @@ The unique identifier of the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#get-a-review-comment-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). diff --git a/docs/pulls/list.md b/docs/pulls/list.md index 63e6f445a..810137a68 100644 --- a/docs/pulls/list.md +++ b/docs/pulls/list.md @@ -76,4 +76,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-pull-requests). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#list-pull-requests). diff --git a/docs/pulls/listCommentsForReview.md b/docs/pulls/listCommentsForReview.md index 32cf34443..9d450fc1c 100644 --- a/docs/pulls/listCommentsForReview.md +++ b/docs/pulls/listCommentsForReview.md @@ -63,4 +63,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-comments-for-a-pull-request-review). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review). diff --git a/docs/pulls/listCommits.md b/docs/pulls/listCommits.md index 7e305afb5..8547456ff 100644 --- a/docs/pulls/listCommits.md +++ b/docs/pulls/listCommits.md @@ -8,7 +8,7 @@ type: API method # List commits on a pull request -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. +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/commits/commits#list-commits) endpoint. ```js octokit.rest.pulls.listCommits({ @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-commits-on-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request). diff --git a/docs/pulls/listFiles.md b/docs/pulls/listFiles.md index 9c2d2ab2b..60e6ee30a 100644 --- a/docs/pulls/listFiles.md +++ b/docs/pulls/listFiles.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-pull-requests-files). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#list-pull-requests-files). diff --git a/docs/pulls/listRequestedReviewers.md b/docs/pulls/listRequestedReviewers.md index 4353a1e49..fd97ee618 100644 --- a/docs/pulls/listRequestedReviewers.md +++ b/docs/pulls/listRequestedReviewers.md @@ -47,4 +47,4 @@ The number that identifies the pull request. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request). diff --git a/docs/pulls/listReviewComments.md b/docs/pulls/listReviewComments.md index 0a81bf1a2..87c48b892 100644 --- a/docs/pulls/listReviewComments.md +++ b/docs/pulls/listReviewComments.md @@ -56,7 +56,7 @@ The direction to sort results. Ignored without `sort` parameter. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -72,4 +72,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-review-comments-on-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request). diff --git a/docs/pulls/listReviewCommentsForRepo.md b/docs/pulls/listReviewCommentsForRepo.md index 1aced72e9..3ca62546e 100644 --- a/docs/pulls/listReviewCommentsForRepo.md +++ b/docs/pulls/listReviewCommentsForRepo.md @@ -48,7 +48,7 @@ The direction to sort results. Ignored without `sort` parameter. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. per_pageno @@ -64,4 +64,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-review-comments-in-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository). diff --git a/docs/pulls/listReviews.md b/docs/pulls/listReviews.md index 40d03ca16..c6e3f6235 100644 --- a/docs/pulls/listReviews.md +++ b/docs/pulls/listReviews.md @@ -57,4 +57,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#list-reviews-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request). diff --git a/docs/pulls/merge.md b/docs/pulls/merge.md index 6e61eb9cb..3dd71ab99 100644 --- a/docs/pulls/merge.md +++ b/docs/pulls/merge.md @@ -68,4 +68,4 @@ The merge method to use. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#merge-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#merge-a-pull-request). diff --git a/docs/pulls/removeRequestedReviewers.md b/docs/pulls/removeRequestedReviewers.md index accc2dce8..77ea43d52 100644 --- a/docs/pulls/removeRequestedReviewers.md +++ b/docs/pulls/removeRequestedReviewers.md @@ -58,4 +58,4 @@ An array of team `slug`s that will be removed. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request). diff --git a/docs/pulls/submitReview.md b/docs/pulls/submitReview.md index f88bc9036..345111946 100644 --- a/docs/pulls/submitReview.md +++ b/docs/pulls/submitReview.md @@ -8,7 +8,7 @@ type: API method # Submit a review for a pull request -Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." +Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." ```js octokit.rest.pulls.submitReview({ @@ -64,4 +64,4 @@ The review action you want to perform. The review actions include: `APPROVE`, `R -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request). diff --git a/docs/pulls/update.md b/docs/pulls/update.md index f7d9e37a3..08421d229 100644 --- a/docs/pulls/update.md +++ b/docs/pulls/update.md @@ -74,4 +74,4 @@ Indicates whether [maintainers can modify](https://docs.github.com/articles/allo -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls/#update-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#update-a-pull-request). diff --git a/docs/pulls/updateBranch.md b/docs/pulls/updateBranch.md index f64b44998..28d678475 100644 --- a/docs/pulls/updateBranch.md +++ b/docs/pulls/updateBranch.md @@ -46,10 +46,10 @@ The number that identifies the pull request. expected_head_shano -The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/reference/repos#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. +The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#update-a-pull-request-branch). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch). diff --git a/docs/pulls/updateReview.md b/docs/pulls/updateReview.md index 70d456136..042f71e04 100644 --- a/docs/pulls/updateReview.md +++ b/docs/pulls/updateReview.md @@ -59,4 +59,4 @@ The body text of the pull request review. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#update-a-review-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request). diff --git a/docs/pulls/updateReviewComment.md b/docs/pulls/updateReviewComment.md index 3bb75f0b4..67d1d4030 100644 --- a/docs/pulls/updateReviewComment.md +++ b/docs/pulls/updateReviewComment.md @@ -53,4 +53,4 @@ The text of the reply to the review comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/pulls#update-a-review-comment-for-a-pull-request). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request). diff --git a/docs/rateLimit/get.md b/docs/rateLimit/get.md index b349125d5..a0f64225c 100644 --- a/docs/rateLimit/get.md +++ b/docs/rateLimit/get.md @@ -10,6 +10,18 @@ type: API method **Note:** Accessing this endpoint does not count against your REST API rate limit. +Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + +- The `core` object provides your rate limit status for all non-search-related resources in the REST API. +- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." +- The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." +- The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." +- The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." +- The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." +- The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." +- The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." +- The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + **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. ```js @@ -20,4 +32,4 @@ octokit.rest.rateLimit.get(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user). diff --git a/docs/reactions/createForCommitComment.md b/docs/reactions/createForCommitComment.md index 702b57d84..1d71bd4ec 100644 --- a/docs/reactions/createForCommitComment.md +++ b/docs/reactions/createForCommitComment.md @@ -8,7 +8,7 @@ type: API method # Create reaction for a commit comment -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. +Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. ```js octokit.rest.reactions.createForCommitComment({ @@ -47,10 +47,10 @@ The unique identifier of the comment. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-commit-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment). diff --git a/docs/reactions/createForIssue.md b/docs/reactions/createForIssue.md index 59d9e37a2..bf6bc6e55 100644 --- a/docs/reactions/createForIssue.md +++ b/docs/reactions/createForIssue.md @@ -8,7 +8,7 @@ type: API method # Create reaction for an issue -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. +Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. ```js octokit.rest.reactions.createForIssue({ @@ -47,10 +47,10 @@ The number that identifies the issue. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue). diff --git a/docs/reactions/createForIssueComment.md b/docs/reactions/createForIssueComment.md index 2488c5cb6..a2ab679c5 100644 --- a/docs/reactions/createForIssueComment.md +++ b/docs/reactions/createForIssueComment.md @@ -8,7 +8,7 @@ type: API method # Create reaction for an issue comment -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. +Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. ```js octokit.rest.reactions.createForIssueComment({ @@ -47,10 +47,10 @@ The unique identifier of the comment. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment). diff --git a/docs/reactions/createForPullRequestReviewComment.md b/docs/reactions/createForPullRequestReviewComment.md index 3645e4019..58d4074d9 100644 --- a/docs/reactions/createForPullRequestReviewComment.md +++ b/docs/reactions/createForPullRequestReviewComment.md @@ -8,7 +8,7 @@ type: API method # Create reaction for a pull request review comment -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. +Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. ```js octokit.rest.reactions.createForPullRequestReviewComment({ @@ -47,10 +47,10 @@ The unique identifier of the comment. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment). diff --git a/docs/reactions/createForRelease.md b/docs/reactions/createForRelease.md index 2aa57d05c..56d0eee8f 100644 --- a/docs/reactions/createForRelease.md +++ b/docs/reactions/createForRelease.md @@ -8,7 +8,7 @@ type: API method # Create reaction for a release -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. +Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. ```js octokit.rest.reactions.createForRelease({ @@ -47,10 +47,10 @@ The unique identifier of the release. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release). diff --git a/docs/reactions/createForTeamDiscussionCommentInOrg.md b/docs/reactions/createForTeamDiscussionCommentInOrg.md index 36ee7a9cf..85d5f051e 100644 --- a/docs/reactions/createForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/createForTeamDiscussionCommentInOrg.md @@ -8,7 +8,7 @@ type: API method # Create reaction for a team discussion comment -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. +Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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. **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`. @@ -55,10 +55,10 @@ The number that identifies the comment. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment). diff --git a/docs/reactions/createForTeamDiscussionInOrg.md b/docs/reactions/createForTeamDiscussionInOrg.md index 0e19e5a29..fa431d76d 100644 --- a/docs/reactions/createForTeamDiscussionInOrg.md +++ b/docs/reactions/createForTeamDiscussionInOrg.md @@ -8,7 +8,7 @@ type: API method # Create reaction for a team discussion -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. +Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). 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. **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`. @@ -49,10 +49,10 @@ The number that identifies the discussion. contentyes -The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion. +The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#create-reaction-for-a-team-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion). diff --git a/docs/reactions/deleteForCommitComment.md b/docs/reactions/deleteForCommitComment.md index c8bbd62d3..80232f624 100644 --- a/docs/reactions/deleteForCommitComment.md +++ b/docs/reactions/deleteForCommitComment.md @@ -10,7 +10,7 @@ type: API method **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. -Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). +Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). ```js octokit.rest.reactions.deleteForCommitComment({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-a-commit-comment-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction). diff --git a/docs/reactions/deleteForIssue.md b/docs/reactions/deleteForIssue.md index c75b30239..7178dc5f1 100644 --- a/docs/reactions/deleteForIssue.md +++ b/docs/reactions/deleteForIssue.md @@ -10,7 +10,7 @@ type: API method **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. -Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). +Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). ```js octokit.rest.reactions.deleteForIssue({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-an-issue-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction). diff --git a/docs/reactions/deleteForIssueComment.md b/docs/reactions/deleteForIssueComment.md index d6a695390..91427a84b 100644 --- a/docs/reactions/deleteForIssueComment.md +++ b/docs/reactions/deleteForIssueComment.md @@ -10,7 +10,7 @@ type: API method **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`. -Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). +Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). ```js octokit.rest.reactions.deleteForIssueComment({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-an-issue-comment-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction). diff --git a/docs/reactions/deleteForPullRequestComment.md b/docs/reactions/deleteForPullRequestComment.md index edbfb3597..2337fe9bf 100644 --- a/docs/reactions/deleteForPullRequestComment.md +++ b/docs/reactions/deleteForPullRequestComment.md @@ -10,7 +10,7 @@ type: API method **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` -Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). +Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). ```js octokit.rest.reactions.deleteForPullRequestComment({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-a-pull-request-comment-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction). diff --git a/docs/reactions/deleteForRelease.md b/docs/reactions/deleteForRelease.md index 6c84c37ae..7f87f42d0 100644 --- a/docs/reactions/deleteForRelease.md +++ b/docs/reactions/deleteForRelease.md @@ -10,7 +10,7 @@ type: API method **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. -Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). +Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). ```js octokit.rest.reactions.deleteForRelease({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions/#delete-a-release-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction). diff --git a/docs/reactions/deleteForTeamDiscussion.md b/docs/reactions/deleteForTeamDiscussion.md index 339ccbf38..c9566e317 100644 --- a/docs/reactions/deleteForTeamDiscussion.md +++ b/docs/reactions/deleteForTeamDiscussion.md @@ -10,7 +10,7 @@ type: API method **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`. -Delete 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/). +Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). ```js octokit.rest.reactions.deleteForTeamDiscussion({ @@ -55,4 +55,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-team-discussion-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction). diff --git a/docs/reactions/deleteForTeamDiscussionComment.md b/docs/reactions/deleteForTeamDiscussionComment.md index 6e91dce7d..d612a5461 100644 --- a/docs/reactions/deleteForTeamDiscussionComment.md +++ b/docs/reactions/deleteForTeamDiscussionComment.md @@ -10,7 +10,7 @@ type: API method **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`. -Delete 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/). +Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). ```js octokit.rest.reactions.deleteForTeamDiscussionComment({ @@ -61,4 +61,4 @@ The unique identifier of the reaction. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#delete-team-discussion-comment-reaction). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction). diff --git a/docs/reactions/listForCommitComment.md b/docs/reactions/listForCommitComment.md index cd7fb4e53..e1ce5391e 100644 --- a/docs/reactions/listForCommitComment.md +++ b/docs/reactions/listForCommitComment.md @@ -8,7 +8,7 @@ type: API method # List reactions for a commit comment -List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). +List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). ```js octokit.rest.reactions.listForCommitComment({ @@ -46,7 +46,7 @@ The unique identifier of the comment. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. per_pageno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-commit-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment). diff --git a/docs/reactions/listForIssue.md b/docs/reactions/listForIssue.md index 5e65d5ce3..723c7c0a2 100644 --- a/docs/reactions/listForIssue.md +++ b/docs/reactions/listForIssue.md @@ -8,7 +8,7 @@ type: API method # List reactions for an issue -List the reactions to an [issue](https://docs.github.com/rest/reference/issues). +List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). ```js octokit.rest.reactions.listForIssue({ @@ -46,7 +46,7 @@ The number that identifies the issue. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. per_pageno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue). diff --git a/docs/reactions/listForIssueComment.md b/docs/reactions/listForIssueComment.md index c95eac3db..5b835d8cd 100644 --- a/docs/reactions/listForIssueComment.md +++ b/docs/reactions/listForIssueComment.md @@ -8,7 +8,7 @@ type: API method # List reactions for an issue comment -List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). +List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). ```js octokit.rest.reactions.listForIssueComment({ @@ -46,7 +46,7 @@ The unique identifier of the comment. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. per_pageno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-an-issue-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment). diff --git a/docs/reactions/listForPullRequestReviewComment.md b/docs/reactions/listForPullRequestReviewComment.md index 5a8e10730..1a7f3d95f 100644 --- a/docs/reactions/listForPullRequestReviewComment.md +++ b/docs/reactions/listForPullRequestReviewComment.md @@ -8,7 +8,7 @@ type: API method # List reactions for a pull request review comment -List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). +List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). ```js octokit.rest.reactions.listForPullRequestReviewComment({ @@ -46,7 +46,7 @@ The unique identifier of the comment. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. per_pageno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment). diff --git a/docs/reactions/listForRelease.md b/docs/reactions/listForRelease.md index c8531be6c..5be638b9d 100644 --- a/docs/reactions/listForRelease.md +++ b/docs/reactions/listForRelease.md @@ -8,7 +8,7 @@ type: API method # List reactions for a release -List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). +List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). ```js octokit.rest.reactions.listForRelease({ @@ -46,7 +46,7 @@ The unique identifier of the release. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. per_pageno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release). diff --git a/docs/reactions/listForTeamDiscussionCommentInOrg.md b/docs/reactions/listForTeamDiscussionCommentInOrg.md index eed9a7f68..09075d73b 100644 --- a/docs/reactions/listForTeamDiscussionCommentInOrg.md +++ b/docs/reactions/listForTeamDiscussionCommentInOrg.md @@ -8,7 +8,7 @@ type: API method # List reactions for a team discussion comment -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/). +List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **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`. @@ -54,7 +54,7 @@ The number that identifies the comment. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. per_pageno @@ -70,4 +70,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment). diff --git a/docs/reactions/listForTeamDiscussionInOrg.md b/docs/reactions/listForTeamDiscussionInOrg.md index dcce96702..1f74d982c 100644 --- a/docs/reactions/listForTeamDiscussionInOrg.md +++ b/docs/reactions/listForTeamDiscussionInOrg.md @@ -8,7 +8,7 @@ type: API method # List reactions for a team discussion -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/). +List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). **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`. @@ -48,7 +48,7 @@ The number that identifies the discussion. contentno -Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. +Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. per_pageno @@ -64,4 +64,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/reactions#list-reactions-for-a-team-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion). diff --git a/docs/repos/addCollaborator.md b/docs/repos/addCollaborator.md index a2351fb43..4c5f2ca90 100644 --- a/docs/repos/addCollaborator.md +++ b/docs/repos/addCollaborator.md @@ -20,7 +20,7 @@ Cannot assign {member} permission of {role name} 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)." -The 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). +The 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 [API](https://docs.github.com/rest/collaborators/invitations). **Updating an existing collaborator's permission level** diff --git a/docs/repos/checkAutomatedSecurityFixes.md b/docs/repos/checkAutomatedSecurityFixes.md new file mode 100644 index 000000000..b5a59e01c --- /dev/null +++ b/docs/repos/checkAutomatedSecurityFixes.md @@ -0,0 +1,44 @@ +--- +name: Check if automated security fixes are enabled for a repository +example: octokit.rest.repos.checkAutomatedSecurityFixes({ owner, repo }) +route: GET /repos/{owner}/{repo}/automated-security-fixes +scope: repos +type: API method +--- + +# Check if automated security fixes are enabled for a repository + +Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + +```js +octokit.rest.repos.checkAutomatedSecurityFixes({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository). diff --git a/docs/repos/checkVulnerabilityAlerts.md b/docs/repos/checkVulnerabilityAlerts.md index 19d74b92f..2370341b9 100644 --- a/docs/repos/checkVulnerabilityAlerts.md +++ b/docs/repos/checkVulnerabilityAlerts.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository). diff --git a/docs/repos/codeownersErrors.md b/docs/repos/codeownersErrors.md index 5c62c5ea6..8c1dcfd49 100644 --- a/docs/repos/codeownersErrors.md +++ b/docs/repos/codeownersErrors.md @@ -50,4 +50,4 @@ A branch, tag or commit name used to determine which version of the CODEOWNERS f -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-codeowners-errors). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-codeowners-errors). diff --git a/docs/repos/createDeployKey.md b/docs/repos/createDeployKey.md index 7afb55cfd..b15e15bf7 100644 --- a/docs/repos/createDeployKey.md +++ b/docs/repos/createDeployKey.md @@ -59,4 +59,4 @@ Deploy keys with write access can perform the same actions as an organization me -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys#create-a-deploy-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key). diff --git a/docs/repos/createDeployment.md b/docs/repos/createDeployment.md index 064f3b8e0..5219c07fb 100644 --- a/docs/repos/createDeployment.md +++ b/docs/repos/createDeployment.md @@ -36,7 +36,7 @@ application with debugging enabled. Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. -#### Merged branch response +Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when: @@ -48,12 +48,12 @@ a deployment. This auto-merge happens when: If there are no new commits in the base branch, a new request to create a deployment should give a successful response. -#### Merge conflict response +Merge conflict response: This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. -#### Failed commit status checks +Failed commit status checks: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. diff --git a/docs/repos/createDeploymentBranchPolicy.md b/docs/repos/createDeploymentBranchPolicy.md index 6f164f4b3..d016cb045 100644 --- a/docs/repos/createDeploymentBranchPolicy.md +++ b/docs/repos/createDeploymentBranchPolicy.md @@ -58,4 +58,4 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy). diff --git a/docs/repos/createDeploymentProtectionRule.md b/docs/repos/createDeploymentProtectionRule.md index d8af5568a..8f48b7f14 100644 --- a/docs/repos/createDeploymentProtectionRule.md +++ b/docs/repos/createDeploymentProtectionRule.md @@ -56,4 +56,4 @@ The ID of the custom app that will be enabled on the environment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment). diff --git a/docs/repos/createDeploymentStatus.md b/docs/repos/createDeploymentStatus.md index 13fe4493d..6ee2a79eb 100644 --- a/docs/repos/createDeploymentStatus.md +++ b/docs/repos/createDeploymentStatus.md @@ -10,7 +10,7 @@ type: API method Users with `push` access can create deployment statuses for a given deployment. -GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. +GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. ```js octokit.rest.repos.createDeploymentStatus({ @@ -69,7 +69,7 @@ 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`. +Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. environment_urlno diff --git a/docs/repos/createDispatchEvent.md b/docs/repos/createDispatchEvent.md index 6c354789c..bb6e83d31 100644 --- a/docs/repos/createDispatchEvent.md +++ b/docs/repos/createDispatchEvent.md @@ -64,4 +64,4 @@ JSON payload with extra information about the webhook event that your action or -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-a-repository-dispatch-event). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). diff --git a/docs/repos/createForAuthenticatedUser.md b/docs/repos/createForAuthenticatedUser.md index 120f95ed6..1b826c986 100644 --- a/docs/repos/createForAuthenticatedUser.md +++ b/docs/repos/createForAuthenticatedUser.md @@ -166,4 +166,4 @@ Whether this repository acts as a template that can be used to generate new repo -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-a-repository-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). diff --git a/docs/repos/createFork.md b/docs/repos/createFork.md index 17ea51fd6..dddc0d213 100644 --- a/docs/repos/createFork.md +++ b/docs/repos/createFork.md @@ -60,4 +60,4 @@ When forking from an existing repository, fork with only the default branch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-a-fork). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/forks#create-a-fork). diff --git a/docs/repos/createInOrg.md b/docs/repos/createInOrg.md index 9d8f70024..e61218154 100644 --- a/docs/repos/createInOrg.md +++ b/docs/repos/createInOrg.md @@ -177,4 +177,4 @@ The default value for a merge commit message. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-an-organization-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#create-an-organization-repository). diff --git a/docs/repos/createOrUpdateEnvironment.md b/docs/repos/createOrUpdateEnvironment.md index e1e4d80fe..4120c751d 100644 --- a/docs/repos/createOrUpdateEnvironment.md +++ b/docs/repos/createOrUpdateEnvironment.md @@ -12,7 +12,7 @@ Create or update an environment with protection rules, such as required reviewer **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." -**Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." +**Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. diff --git a/docs/repos/createOrUpdateFileContents.md b/docs/repos/createOrUpdateFileContents.md index 46a832fd8..e86ba27a4 100644 --- a/docs/repos/createOrUpdateFileContents.md +++ b/docs/repos/createOrUpdateFileContents.md @@ -8,9 +8,9 @@ type: API method # Create or update file contents -Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. +Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. -**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. +**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. ```js octokit.rest.repos.createOrUpdateFileContents({ @@ -111,4 +111,4 @@ The email of the author or committer of the commit. You'll receive a `422` statu -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-or-update-file-contents). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#create-or-update-file-contents). diff --git a/docs/repos/createOrgRuleset.md b/docs/repos/createOrgRuleset.md index c4ba17200..eaff17362 100644 --- a/docs/repos/createOrgRuleset.md +++ b/docs/repos/createOrgRuleset.md @@ -1,6 +1,6 @@ --- name: Create an organization repository ruleset -example: octokit.rest.repos.createOrgRuleset({ org, name, enforcement, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.createOrgRuleset({ org, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) route: POST /orgs/{org}/rulesets scope: repos type: API method @@ -15,6 +15,9 @@ octokit.rest.repos.createOrgRuleset({ org, name, enforcement, +bypass_actors[].actor_id, +bypass_actors[].actor_type, +bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, @@ -67,19 +70,24 @@ The enforcement level of the ruleset. `evaluate` allows admins to test rules bef The actors that can bypass the rules in this ruleset -bypass_actors[].actor_idno +bypass_actors[].actor_idyes The ID of the actor that can bypass a ruleset -bypass_actors[].actor_typeno +bypass_actors[].actor_typeyes The type of actor that can bypass a ruleset + +bypass_actors[].bypass_modeyes + +When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + conditionsno -Conditions for a organization ruleset +Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. rulesno @@ -171,4 +179,4 @@ The pattern to match with. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#create-organization-repository-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset). diff --git a/docs/repos/createPagesDeployment.md b/docs/repos/createPagesDeployment.md index e8d9949fe..b877aabd7 100644 --- a/docs/repos/createPagesDeployment.md +++ b/docs/repos/createPagesDeployment.md @@ -66,4 +66,4 @@ The OIDC token issued by GitHub Actions certifying the origin of the deployment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#create-a-github-pages-deployment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment). diff --git a/docs/repos/createPagesSite.md b/docs/repos/createPagesSite.md index 2d26d0da0..0432c8bde 100644 --- a/docs/repos/createPagesSite.md +++ b/docs/repos/createPagesSite.md @@ -64,4 +64,4 @@ The repository directory that includes the source files for the Pages site. Allo -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#create-a-github-pages-site). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site). diff --git a/docs/repos/createRepoRuleset.md b/docs/repos/createRepoRuleset.md index 273bb68fa..f8779551c 100644 --- a/docs/repos/createRepoRuleset.md +++ b/docs/repos/createRepoRuleset.md @@ -1,6 +1,6 @@ --- name: Create a repository ruleset -example: octokit.rest.repos.createRepoRuleset({ owner, repo, name, enforcement, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.createRepoRuleset({ owner, repo, name, enforcement, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) route: POST /repos/{owner}/{repo}/rulesets scope: repos type: API method @@ -16,6 +16,9 @@ octokit.rest.repos.createRepoRuleset({ repo, name, enforcement, +bypass_actors[].actor_id, +bypass_actors[].actor_type, +bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, @@ -67,26 +70,26 @@ The target of the ruleset. The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - -bypass_modeno - -The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing. - bypass_actorsno The actors that can bypass the rules in this ruleset -bypass_actors[].actor_idno +bypass_actors[].actor_idyes The ID of the actor that can bypass a ruleset -bypass_actors[].actor_typeno +bypass_actors[].actor_typeyes The type of actor that can bypass a ruleset + +bypass_actors[].bypass_modeyes + +When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + conditionsno @@ -195,4 +198,4 @@ The pattern to match with. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#create-repository-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset). diff --git a/docs/repos/createTagProtection.md b/docs/repos/createTagProtection.md index 2ed82956e..5dbf1b6a0 100644 --- a/docs/repos/createTagProtection.md +++ b/docs/repos/createTagProtection.md @@ -48,4 +48,4 @@ An optional glob pattern to match against when enforcing tag protection. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-tag-protection-state-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository). diff --git a/docs/repos/createUsingTemplate.md b/docs/repos/createUsingTemplate.md index 61a9b152e..2f65bded7 100644 --- a/docs/repos/createUsingTemplate.md +++ b/docs/repos/createUsingTemplate.md @@ -8,7 +8,7 @@ type: API method # Create a repository using a template -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. If the repository is not public, 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`. +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. If the repository is not public, 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/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. **OAuth scope requirements** @@ -38,9 +38,13 @@ octokit.rest.repos.createUsingTemplate({ template_owneryes +The account owner of the template repository. The name is not case sensitive. + template_repoyes +The name of the template repository without the `.git` extension. The name is not case sensitive. + ownerno @@ -70,4 +74,4 @@ Either `true` to create a new private repository or `false` to create a new publ -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#create-a-repository-using-a-template). diff --git a/docs/repos/createWebhook.md b/docs/repos/createWebhook.md index 324abc924..1bcf8d1cb 100644 --- a/docs/repos/createWebhook.md +++ b/docs/repos/createWebhook.md @@ -46,7 +46,7 @@ Use `web` to create a webhook. Default: `web`. This parameter only accepts the v configno -Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). +Key/value pairs to provide settings for this webhook. config.urlno diff --git a/docs/repos/delete.md b/docs/repos/delete.md index 8ed32df15..ed9636514 100644 --- a/docs/repos/delete.md +++ b/docs/repos/delete.md @@ -44,4 +44,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#delete-a-repository). diff --git a/docs/repos/deleteDeployKey.md b/docs/repos/deleteDeployKey.md index 6778c38be..c06fe772d 100644 --- a/docs/repos/deleteDeployKey.md +++ b/docs/repos/deleteDeployKey.md @@ -47,4 +47,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys#delete-a-deploy-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key). diff --git a/docs/repos/deleteDeployment.md b/docs/repos/deleteDeployment.md index 3a53efd4a..f17649cb6 100644 --- a/docs/repos/deleteDeployment.md +++ b/docs/repos/deleteDeployment.md @@ -15,7 +15,7 @@ To set a deployment as inactive, you must: - Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - Mark the active deployment as inactive by adding any non-successful deployment status. -For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)." +For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." ```js octokit.rest.repos.deleteDeployment({ diff --git a/docs/repos/deleteDeploymentBranchPolicy.md b/docs/repos/deleteDeploymentBranchPolicy.md index 76fa498e4..a7c7eae89 100644 --- a/docs/repos/deleteDeploymentBranchPolicy.md +++ b/docs/repos/deleteDeploymentBranchPolicy.md @@ -55,4 +55,4 @@ The unique identifier of the branch policy. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy). diff --git a/docs/repos/deleteFile.md b/docs/repos/deleteFile.md index bcfdcf5bf..31988ac82 100644 --- a/docs/repos/deleteFile.md +++ b/docs/repos/deleteFile.md @@ -16,7 +16,7 @@ The `author` section is optional and is filled in with the `committer` informati You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. -**Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. +**Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. ```js octokit.rest.repos.deleteFile({ @@ -102,4 +102,4 @@ The email of the author (or committer) of the commit -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-a-file). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#delete-a-file). diff --git a/docs/repos/deleteOrgRuleset.md b/docs/repos/deleteOrgRuleset.md index a3347a01c..334f047ed 100644 --- a/docs/repos/deleteOrgRuleset.md +++ b/docs/repos/deleteOrgRuleset.md @@ -41,4 +41,4 @@ The ID of the ruleset. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#delete-organization-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset). diff --git a/docs/repos/deletePagesSite.md b/docs/repos/deletePagesSite.md index 9a6ba3373..f327061c5 100644 --- a/docs/repos/deletePagesSite.md +++ b/docs/repos/deletePagesSite.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#delete-a-github-pages-site). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site). diff --git a/docs/repos/deleteRelease.md b/docs/repos/deleteRelease.md index 2c8ad0f9b..5c63438b1 100644 --- a/docs/repos/deleteRelease.md +++ b/docs/repos/deleteRelease.md @@ -47,4 +47,4 @@ The unique identifier of the release. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-a-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#delete-a-release). diff --git a/docs/repos/deleteReleaseAsset.md b/docs/repos/deleteReleaseAsset.md index d473df4f1..db0c7a1cb 100644 --- a/docs/repos/deleteReleaseAsset.md +++ b/docs/repos/deleteReleaseAsset.md @@ -45,4 +45,4 @@ The unique identifier of the asset. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-a-release-asset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/assets#delete-a-release-asset). diff --git a/docs/repos/deleteRepoRuleset.md b/docs/repos/deleteRepoRuleset.md index cba92ee2d..af3a9982c 100644 --- a/docs/repos/deleteRepoRuleset.md +++ b/docs/repos/deleteRepoRuleset.md @@ -47,4 +47,4 @@ The ID of the ruleset. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#delete-repository-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset). diff --git a/docs/repos/deleteTagProtection.md b/docs/repos/deleteTagProtection.md index 940c597a2..ba262de24 100644 --- a/docs/repos/deleteTagProtection.md +++ b/docs/repos/deleteTagProtection.md @@ -48,4 +48,4 @@ The unique identifier of the tag protection. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#delete-tag-protection-state-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository). diff --git a/docs/repos/disableAutomatedSecurityFixes.md b/docs/repos/disableAutomatedSecurityFixes.md index 7b5a7a1a7..568a67dda 100644 --- a/docs/repos/disableAutomatedSecurityFixes.md +++ b/docs/repos/disableAutomatedSecurityFixes.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#disable-automated-security-fixes). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#disable-automated-security-fixes). diff --git a/docs/repos/disableDeploymentProtectionRule.md b/docs/repos/disableDeploymentProtectionRule.md index a747da519..e027c13fe 100644 --- a/docs/repos/disableDeploymentProtectionRule.md +++ b/docs/repos/disableDeploymentProtectionRule.md @@ -55,4 +55,4 @@ The unique identifier of the protection rule. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment). diff --git a/docs/repos/disableLfsForRepo.md b/docs/repos/disableLfsForRepo.md deleted file mode 100644 index 9019a15bf..000000000 --- a/docs/repos/disableLfsForRepo.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Disable Git LFS for a repository -example: octokit.rest.repos.disableLfsForRepo({ owner, repo }) -route: DELETE /repos/{owner}/{repo}/lfs -scope: repos -type: API method ---- - -# Disable Git LFS for a repository - -Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - -```js -octokit.rest.repos.disableLfsForRepo({ - owner, - repo, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
owneryes - -The account owner of the repository. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository). diff --git a/docs/repos/disablePrivateVulnerabilityReporting.md b/docs/repos/disablePrivateVulnerabilityReporting.md new file mode 100644 index 000000000..634ebfe70 --- /dev/null +++ b/docs/repos/disablePrivateVulnerabilityReporting.md @@ -0,0 +1,44 @@ +--- +name: Disable private vulnerability reporting for a repository +example: octokit.rest.repos.disablePrivateVulnerabilityReporting({ owner, repo }) +route: DELETE /repos/{owner}/{repo}/private-vulnerability-reporting +scope: repos +type: API method +--- + +# Disable private vulnerability reporting for a repository + +Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". + +```js +octokit.rest.repos.disablePrivateVulnerabilityReporting({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository). diff --git a/docs/repos/disableVulnerabilityAlerts.md b/docs/repos/disableVulnerabilityAlerts.md index 50ba2da0d..1a20c8b63 100644 --- a/docs/repos/disableVulnerabilityAlerts.md +++ b/docs/repos/disableVulnerabilityAlerts.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts). diff --git a/docs/repos/downloadArchive.md b/docs/repos/downloadArchive.md index 72c65e96b..b1ade5a95 100644 --- a/docs/repos/downloadArchive.md +++ b/docs/repos/downloadArchive.md @@ -51,4 +51,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#download-a-repository-archive). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip). diff --git a/docs/repos/downloadTarballArchive.md b/docs/repos/downloadTarballArchive.md index ada30a630..1c983b550 100644 --- a/docs/repos/downloadTarballArchive.md +++ b/docs/repos/downloadTarballArchive.md @@ -48,4 +48,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#download-a-repository-archive). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar). diff --git a/docs/repos/downloadZipballArchive.md b/docs/repos/downloadZipballArchive.md index c1267ff1d..c1b11cff6 100644 --- a/docs/repos/downloadZipballArchive.md +++ b/docs/repos/downloadZipballArchive.md @@ -49,4 +49,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#download-a-repository-archive). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip). diff --git a/docs/repos/enableAutomatedSecurityFixes.md b/docs/repos/enableAutomatedSecurityFixes.md index 973028334..6e3d12c74 100644 --- a/docs/repos/enableAutomatedSecurityFixes.md +++ b/docs/repos/enableAutomatedSecurityFixes.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#enable-automated-security-fixes). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#enable-automated-security-fixes). diff --git a/docs/repos/enableLfsForRepo.md b/docs/repos/enableLfsForRepo.md deleted file mode 100644 index 26be0b44e..000000000 --- a/docs/repos/enableLfsForRepo.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Enable Git LFS for a repository -example: octokit.rest.repos.enableLfsForRepo({ owner, repo }) -route: PUT /repos/{owner}/{repo}/lfs -scope: repos -type: API method ---- - -# Enable Git LFS for a repository - -Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - -```js -octokit.rest.repos.enableLfsForRepo({ - owner, - repo, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
owneryes - -The account owner of the repository. The name is not case sensitive. - -
repoyes - -The name of the repository without the `.git` extension. The name is not case sensitive. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository). diff --git a/docs/repos/enablePrivateVulnerabilityReporting.md b/docs/repos/enablePrivateVulnerabilityReporting.md new file mode 100644 index 000000000..fa782825f --- /dev/null +++ b/docs/repos/enablePrivateVulnerabilityReporting.md @@ -0,0 +1,44 @@ +--- +name: Enable private vulnerability reporting for a repository +example: octokit.rest.repos.enablePrivateVulnerabilityReporting({ owner, repo }) +route: PUT /repos/{owner}/{repo}/private-vulnerability-reporting +scope: repos +type: API method +--- + +# Enable private vulnerability reporting for a repository + +Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." + +```js +octokit.rest.repos.enablePrivateVulnerabilityReporting({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository). diff --git a/docs/repos/enableVulnerabilityAlerts.md b/docs/repos/enableVulnerabilityAlerts.md index 0980dee6d..3ab2705e9 100644 --- a/docs/repos/enableVulnerabilityAlerts.md +++ b/docs/repos/enableVulnerabilityAlerts.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts). diff --git a/docs/repos/generateReleaseNotes.md b/docs/repos/generateReleaseNotes.md index bdaade79c..68a4c3dcb 100644 --- a/docs/repos/generateReleaseNotes.md +++ b/docs/repos/generateReleaseNotes.md @@ -8,7 +8,7 @@ type: API method # Generate release notes content for a release -Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. +Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. ```js octokit.rest.repos.generateReleaseNotes({ @@ -62,4 +62,4 @@ Specifies a path to a file in the repository containing configuration settings u -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#generate-release-notes). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release). diff --git a/docs/repos/get.md b/docs/repos/get.md index 10c9c8f22..b2b7bd4e0 100644 --- a/docs/repos/get.md +++ b/docs/repos/get.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#get-a-repository). diff --git a/docs/repos/getAllDeploymentProtectionRules.md b/docs/repos/getAllDeploymentProtectionRules.md index c8fab56f0..fc30478b3 100644 --- a/docs/repos/getAllDeploymentProtectionRules.md +++ b/docs/repos/getAllDeploymentProtectionRules.md @@ -49,4 +49,4 @@ The account owner of the repository. The name is not case sensitive. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment). diff --git a/docs/repos/getAllTopics.md b/docs/repos/getAllTopics.md index 585732be2..a3a1e35cb 100644 --- a/docs/repos/getAllTopics.md +++ b/docs/repos/getAllTopics.md @@ -49,4 +49,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-all-repository-topics). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#get-all-repository-topics). diff --git a/docs/repos/getAppsWithAccessToProtectedBranch.md b/docs/repos/getAppsWithAccessToProtectedBranch.md index 02577b795..747dfc500 100644 --- a/docs/repos/getAppsWithAccessToProtectedBranch.md +++ b/docs/repos/getAppsWithAccessToProtectedBranch.md @@ -49,4 +49,4 @@ The name of the branch. Cannot contain wildcard characters. To use wildcard char -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch). diff --git a/docs/repos/getBranchRules.md b/docs/repos/getBranchRules.md index dc244f75e..148cb9897 100644 --- a/docs/repos/getBranchRules.md +++ b/docs/repos/getBranchRules.md @@ -8,7 +8,10 @@ type: API method # Get rules for a branch -Returns all rules that apply to the specified branch. +Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply +to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level +at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" +enforcement statuses are not returned. ```js octokit.rest.repos.getBranchRules({ diff --git a/docs/repos/getCollaboratorPermissionLevel.md b/docs/repos/getCollaboratorPermissionLevel.md index e3d04ca9b..5c8f7801f 100644 --- a/docs/repos/getCollaboratorPermissionLevel.md +++ b/docs/repos/getCollaboratorPermissionLevel.md @@ -8,7 +8,13 @@ type: API method # Get repository permissions for a user -Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. +Checks the repository permission of a collaborator. The possible repository +permissions are `admin`, `write`, `read`, and `none`. + +_Note_: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the +`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the +collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The +`permissions` hash can also be used to determine which base level of access the collaborator has to the repository. ```js octokit.rest.repos.getCollaboratorPermissionLevel({ diff --git a/docs/repos/getCombinedStatusForRef.md b/docs/repos/getCombinedStatusForRef.md index 9da404746..988288e37 100644 --- a/docs/repos/getCombinedStatusForRef.md +++ b/docs/repos/getCombinedStatusForRef.md @@ -47,7 +47,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. per_pageno diff --git a/docs/repos/getCommit.md b/docs/repos/getCommit.md index b562fc98c..79936cd05 100644 --- a/docs/repos/getCommit.md +++ b/docs/repos/getCommit.md @@ -86,7 +86,7 @@ The number of results per page (max 100). refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. diff --git a/docs/repos/getContent.md b/docs/repos/getContent.md index aad9e6c73..ca158c37a 100644 --- a/docs/repos/getContent.md +++ b/docs/repos/getContent.md @@ -11,41 +11,35 @@ type: API method Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. -Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for +Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media -type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent +type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent object format. **Notes**: -- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). +- To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - API](https://docs.github.com/rest/reference/git#get-a-tree). + API](https://docs.github.com/rest/git/trees#get-a-tree). - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - -#### Size limits - -If the requested file's size is: - + Size limits: + If the requested file's size is: - 1 MB or smaller: All features of this endpoint are supported. - Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - Greater than 100 MB: This endpoint is not supported. -#### If the content is a directory - +If the content is a directory: The response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". -#### If the content is a symlink - +If the content is a symlink: If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object describing the symlink itself. -#### If the content is a submodule - +If the content is a submodule: The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. @@ -95,4 +89,4 @@ The name of the commit/branch/tag. Default: the repository’s default branch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-repository-content). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#get-repository-content). diff --git a/docs/repos/getCustomDeploymentProtectionRule.md b/docs/repos/getCustomDeploymentProtectionRule.md index 2246e544d..56001e3b2 100644 --- a/docs/repos/getCustomDeploymentProtectionRule.md +++ b/docs/repos/getCustomDeploymentProtectionRule.md @@ -55,4 +55,4 @@ The unique identifier of the protection rule. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule). diff --git a/docs/repos/getDeployKey.md b/docs/repos/getDeployKey.md index d1de5d927..8c2d496a9 100644 --- a/docs/repos/getDeployKey.md +++ b/docs/repos/getDeployKey.md @@ -45,4 +45,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys#get-a-deploy-key). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key). diff --git a/docs/repos/getDeploymentBranchPolicy.md b/docs/repos/getDeploymentBranchPolicy.md index a5d552666..9f9e6104d 100644 --- a/docs/repos/getDeploymentBranchPolicy.md +++ b/docs/repos/getDeploymentBranchPolicy.md @@ -55,4 +55,4 @@ The unique identifier of the branch policy. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy). diff --git a/docs/repos/getLatestPagesBuild.md b/docs/repos/getLatestPagesBuild.md index 5de7b1c4e..52159f764 100644 --- a/docs/repos/getLatestPagesBuild.md +++ b/docs/repos/getLatestPagesBuild.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#get-latest-pages-build). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#get-latest-pages-build). diff --git a/docs/repos/getLatestRelease.md b/docs/repos/getLatestRelease.md index e8e6b6a27..25c106b39 100644 --- a/docs/repos/getLatestRelease.md +++ b/docs/repos/getLatestRelease.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-the-latest-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#get-the-latest-release). diff --git a/docs/repos/getOrgRuleset.md b/docs/repos/getOrgRuleset.md index 71ad5a98e..04b973c94 100644 --- a/docs/repos/getOrgRuleset.md +++ b/docs/repos/getOrgRuleset.md @@ -41,4 +41,4 @@ The ID of the ruleset. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-organization-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset). diff --git a/docs/repos/getOrgRulesets.md b/docs/repos/getOrgRulesets.md index 09fff66cc..66a82cc45 100644 --- a/docs/repos/getOrgRulesets.md +++ b/docs/repos/getOrgRulesets.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-organization-rulesets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets). diff --git a/docs/repos/getPages.md b/docs/repos/getPages.md index b5ede69fa..ea239939c 100644 --- a/docs/repos/getPages.md +++ b/docs/repos/getPages.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#get-a-github-pages-site). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site). diff --git a/docs/repos/getPagesBuild.md b/docs/repos/getPagesBuild.md index c701b334f..0a3bbac98 100644 --- a/docs/repos/getPagesBuild.md +++ b/docs/repos/getPagesBuild.md @@ -47,4 +47,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#get-github-pages-build). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#get-apiname-pages-build). diff --git a/docs/repos/getPagesHealthCheck.md b/docs/repos/getPagesHealthCheck.md index 58898710c..fa2470921 100644 --- a/docs/repos/getPagesHealthCheck.md +++ b/docs/repos/getPagesHealthCheck.md @@ -45,4 +45,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#get-a-dns-health-check-for-github-pages). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages). diff --git a/docs/repos/getReadme.md b/docs/repos/getReadme.md index 9ceddcb13..5be2ddd5a 100644 --- a/docs/repos/getReadme.md +++ b/docs/repos/getReadme.md @@ -10,7 +10,7 @@ type: API method Gets the preferred README for a repository. -READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. +READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. ```js octokit.rest.repos.getReadme({ @@ -48,4 +48,4 @@ The name of the commit/branch/tag. Default: the repository’s default branch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-repository-readme). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#get-a-repository-readme). diff --git a/docs/repos/getReadmeInDirectory.md b/docs/repos/getReadmeInDirectory.md index 37393b896..c883b0d1d 100644 --- a/docs/repos/getReadmeInDirectory.md +++ b/docs/repos/getReadmeInDirectory.md @@ -10,7 +10,7 @@ type: API method Gets the README from a repository directory. -READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. +READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. ```js octokit.rest.repos.getReadmeInDirectory({ @@ -54,4 +54,4 @@ The name of the commit/branch/tag. Default: the repository’s default branch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-repository-directory-readme). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory). diff --git a/docs/repos/getRelease.md b/docs/repos/getRelease.md index ec7169365..8909cff15 100644 --- a/docs/repos/getRelease.md +++ b/docs/repos/getRelease.md @@ -47,4 +47,4 @@ The unique identifier of the release. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#get-a-release). diff --git a/docs/repos/getReleaseAsset.md b/docs/repos/getReleaseAsset.md index 98cb3237b..5e92e5372 100644 --- a/docs/repos/getReleaseAsset.md +++ b/docs/repos/getReleaseAsset.md @@ -47,4 +47,4 @@ The unique identifier of the asset. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-release-asset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/assets#get-a-release-asset). diff --git a/docs/repos/getReleaseByTag.md b/docs/repos/getReleaseByTag.md index cf6db95ae..fb9ed59ff 100644 --- a/docs/repos/getReleaseByTag.md +++ b/docs/repos/getReleaseByTag.md @@ -47,4 +47,4 @@ tag parameter -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#get-a-release-by-tag-name). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name). diff --git a/docs/repos/getRepoRuleset.md b/docs/repos/getRepoRuleset.md index ed54ff450..bb7958ba1 100644 --- a/docs/repos/getRepoRuleset.md +++ b/docs/repos/getRepoRuleset.md @@ -52,4 +52,4 @@ Include rulesets configured at higher levels that apply to this repository -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-repository-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-a-repository-ruleset). diff --git a/docs/repos/getRepoRulesets.md b/docs/repos/getRepoRulesets.md index ef11040b0..3c114e989 100644 --- a/docs/repos/getRepoRulesets.md +++ b/docs/repos/getRepoRulesets.md @@ -56,4 +56,4 @@ Include rulesets configured at higher levels that apply to this repository -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-repository-rulesets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets). diff --git a/docs/repos/getTeamsWithAccessToProtectedBranch.md b/docs/repos/getTeamsWithAccessToProtectedBranch.md index b95844cb2..a5c8bb84c 100644 --- a/docs/repos/getTeamsWithAccessToProtectedBranch.md +++ b/docs/repos/getTeamsWithAccessToProtectedBranch.md @@ -49,4 +49,4 @@ The name of the branch. Cannot contain wildcard characters. To use wildcard char -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch). diff --git a/docs/repos/getUsersWithAccessToProtectedBranch.md b/docs/repos/getUsersWithAccessToProtectedBranch.md index f23114f78..ad70e3f84 100644 --- a/docs/repos/getUsersWithAccessToProtectedBranch.md +++ b/docs/repos/getUsersWithAccessToProtectedBranch.md @@ -49,4 +49,4 @@ The name of the branch. Cannot contain wildcard characters. To use wildcard char -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch). diff --git a/docs/repos/getWebhook.md b/docs/repos/getWebhook.md index 3c697b0db..f3ea7b1ce 100644 --- a/docs/repos/getWebhook.md +++ b/docs/repos/getWebhook.md @@ -8,7 +8,7 @@ type: API method # Get a repository webhook -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)." +Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." ```js octokit.rest.repos.getWebhook({ diff --git a/docs/repos/getWebhookConfigForRepo.md b/docs/repos/getWebhookConfigForRepo.md index 2e1de2082..f976ab858 100644 --- a/docs/repos/getWebhookConfigForRepo.md +++ b/docs/repos/getWebhookConfigForRepo.md @@ -8,7 +8,7 @@ type: API method # Get a webhook configuration for a repository -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)." +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/webhooks/repos#get-a-repository-webhook)." Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. diff --git a/docs/repos/listActivities.md b/docs/repos/listActivities.md new file mode 100644 index 000000000..7289a2a66 --- /dev/null +++ b/docs/repos/listActivities.md @@ -0,0 +1,93 @@ +--- +name: List repository activities +example: octokit.rest.repos.listActivities({ owner, repo }) +route: GET /repos/{owner}/{repo}/activity +scope: repos +type: API method +--- + +# List repository activities + +Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. + +For more information about viewing repository activity, +see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + +```js +octokit.rest.repos.listActivities({ + owner, + repo, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
directionno + +The direction to sort the results by. + +
per_pageno + +The number of results per page (max 100). + +
beforeno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. + +
afterno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. + +
refno + +The Git reference for the activities you want to list. + +The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. + +
actorno + +The GitHub username to use to filter by the actor who performed the activity. + +
time_periodno + +The time period to filter by. + +For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). + +
activity_typeno + +The activity type to filter by. + +For example, you can choose to filter by "force_push", to see all force pushes to the repository. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repository-activities). diff --git a/docs/repos/listCommitCommentsForRepo.md b/docs/repos/listCommitCommentsForRepo.md index e9ca23577..ff51468ba 100644 --- a/docs/repos/listCommitCommentsForRepo.md +++ b/docs/repos/listCommitCommentsForRepo.md @@ -8,7 +8,7 @@ type: API method # List commit comments for a repository -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/). +Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). Comments are ordered by ascending ID. diff --git a/docs/repos/listCommitStatusesForRef.md b/docs/repos/listCommitStatusesForRef.md index af6027c59..d55107fa1 100644 --- a/docs/repos/listCommitStatusesForRef.md +++ b/docs/repos/listCommitStatusesForRef.md @@ -43,7 +43,7 @@ The name of the repository without the `.git` extension. The name is not case se refyes -ref parameter +The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. per_pageno diff --git a/docs/repos/listCommits.md b/docs/repos/listCommits.md index b792b6bcf..c09cac82a 100644 --- a/docs/repos/listCommits.md +++ b/docs/repos/listCommits.md @@ -87,7 +87,7 @@ GitHub username or email address to use to filter by commit committer. sinceno -Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. +Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. untilno diff --git a/docs/repos/listContributors.md b/docs/repos/listContributors.md index 3bc21efc2..34c71d476 100644 --- a/docs/repos/listContributors.md +++ b/docs/repos/listContributors.md @@ -58,4 +58,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repository-contributors). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repository-contributors). diff --git a/docs/repos/listCustomDeploymentRuleIntegrations.md b/docs/repos/listCustomDeploymentRuleIntegrations.md index 176c6333a..b31e963f2 100644 --- a/docs/repos/listCustomDeploymentRuleIntegrations.md +++ b/docs/repos/listCustomDeploymentRuleIntegrations.md @@ -61,4 +61,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment). diff --git a/docs/repos/listDeployKeys.md b/docs/repos/listDeployKeys.md index 8bc879c4e..9cacb9f95 100644 --- a/docs/repos/listDeployKeys.md +++ b/docs/repos/listDeployKeys.md @@ -49,4 +49,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys#list-deploy-keys). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys). diff --git a/docs/repos/listForAuthenticatedUser.md b/docs/repos/listForAuthenticatedUser.md index 937655a19..dfcb4d53c 100644 --- a/docs/repos/listForAuthenticatedUser.md +++ b/docs/repos/listForAuthenticatedUser.md @@ -79,4 +79,4 @@ Only show repositories updated before the given time. This is a timestamp in [IS -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repositories-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user). diff --git a/docs/repos/listForOrg.md b/docs/repos/listForOrg.md index d476f0758..3bc1b8c0a 100644 --- a/docs/repos/listForOrg.md +++ b/docs/repos/listForOrg.md @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-organization-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-organization-repositories). diff --git a/docs/repos/listForUser.md b/docs/repos/listForUser.md index 09df94570..4dcc5b159 100644 --- a/docs/repos/listForUser.md +++ b/docs/repos/listForUser.md @@ -60,4 +60,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repositories-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repositories-for-a-user). diff --git a/docs/repos/listForks.md b/docs/repos/listForks.md index e556b1991..40839d7bc 100644 --- a/docs/repos/listForks.md +++ b/docs/repos/listForks.md @@ -54,4 +54,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-forks). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/forks#list-forks). diff --git a/docs/repos/listLanguages.md b/docs/repos/listLanguages.md index 6aa844c44..d1480b62a 100644 --- a/docs/repos/listLanguages.md +++ b/docs/repos/listLanguages.md @@ -41,4 +41,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repository-languages). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repository-languages). diff --git a/docs/repos/listPagesBuilds.md b/docs/repos/listPagesBuilds.md index 0ad93b032..10e004450 100644 --- a/docs/repos/listPagesBuilds.md +++ b/docs/repos/listPagesBuilds.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#list-github-pages-builds). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#list-apiname-pages-builds). diff --git a/docs/repos/listPublic.md b/docs/repos/listPublic.md index fb688b754..529b249e5 100644 --- a/docs/repos/listPublic.md +++ b/docs/repos/listPublic.md @@ -38,4 +38,4 @@ A repository ID. Only return repositories with an ID greater than this ID. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-public-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-public-repositories). diff --git a/docs/repos/listPullRequestsAssociatedWithCommit.md b/docs/repos/listPullRequestsAssociatedWithCommit.md index 3ee4710db..89d44edd7 100644 --- a/docs/repos/listPullRequestsAssociatedWithCommit.md +++ b/docs/repos/listPullRequestsAssociatedWithCommit.md @@ -10,6 +10,8 @@ type: API method Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. +To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + ```js octokit.rest.repos.listPullRequestsAssociatedWithCommit({ owner, diff --git a/docs/repos/listReleaseAssets.md b/docs/repos/listReleaseAssets.md index 53cb758db..0be348ad1 100644 --- a/docs/repos/listReleaseAssets.md +++ b/docs/repos/listReleaseAssets.md @@ -55,4 +55,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-release-assets). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/assets#list-release-assets). diff --git a/docs/repos/listReleases.md b/docs/repos/listReleases.md index 0b34ad394..082742b3d 100644 --- a/docs/repos/listReleases.md +++ b/docs/repos/listReleases.md @@ -8,7 +8,7 @@ type: API method # List releases -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). +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/repos/repos#list-repository-tags). Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-releases). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#list-releases). diff --git a/docs/repos/listTagProtection.md b/docs/repos/listTagProtection.md index 0c96e50e0..c778482c5 100644 --- a/docs/repos/listTagProtection.md +++ b/docs/repos/listTagProtection.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-tag-protection-state-of-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository). diff --git a/docs/repos/listTags.md b/docs/repos/listTags.md index 8ddc4c934..5e439ba99 100644 --- a/docs/repos/listTags.md +++ b/docs/repos/listTags.md @@ -49,4 +49,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repository-tags). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repository-tags). diff --git a/docs/repos/listTeams.md b/docs/repos/listTeams.md index 86bbed424..1a72c4287 100644 --- a/docs/repos/listTeams.md +++ b/docs/repos/listTeams.md @@ -60,4 +60,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#list-repository-teams). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#list-repository-teams). diff --git a/docs/repos/replaceAllTopics.md b/docs/repos/replaceAllTopics.md index 542f38854..3d1603fda 100644 --- a/docs/repos/replaceAllTopics.md +++ b/docs/repos/replaceAllTopics.md @@ -45,4 +45,4 @@ An array of topics to add to the repository. Pass one or more topics to _replace -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#replace-all-repository-topics). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#replace-all-repository-topics). diff --git a/docs/repos/requestPagesBuild.md b/docs/repos/requestPagesBuild.md index 87e3335d1..644d40b99 100644 --- a/docs/repos/requestPagesBuild.md +++ b/docs/repos/requestPagesBuild.md @@ -43,4 +43,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#request-a-github-pages-build). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build). diff --git a/docs/repos/transfer.md b/docs/repos/transfer.md index 943094062..f0abdaf7d 100644 --- a/docs/repos/transfer.md +++ b/docs/repos/transfer.md @@ -9,6 +9,7 @@ type: API method # Transfer a repository 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://docs.github.com/articles/about-repository-transfers/). +You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. ```js octokit.rest.repos.transfer({ @@ -57,4 +58,4 @@ ID of the team or teams to add to the repository. Teams can only be added to org -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#transfer-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/repos#transfer-a-repository). diff --git a/docs/repos/update.md b/docs/repos/update.md index a228d048b..dcceb425b 100644 --- a/docs/repos/update.md +++ b/docs/repos/update.md @@ -8,7 +8,7 @@ type: API method # Update a repository -**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. +**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. ```js octokit.rest.repos.update({ diff --git a/docs/repos/updateDeploymentBranchPolicy.md b/docs/repos/updateDeploymentBranchPolicy.md index 6f10df6b2..c5a8096af 100644 --- a/docs/repos/updateDeploymentBranchPolicy.md +++ b/docs/repos/updateDeploymentBranchPolicy.md @@ -64,4 +64,4 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy). diff --git a/docs/repos/updateInformationAboutPagesSite.md b/docs/repos/updateInformationAboutPagesSite.md index 68234ce43..0784545ff 100644 --- a/docs/repos/updateInformationAboutPagesSite.md +++ b/docs/repos/updateInformationAboutPagesSite.md @@ -61,4 +61,4 @@ The process by which the GitHub Pages site will be built. `workflow` means that -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages#update-information-about-a-github-pages-site). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site). diff --git a/docs/repos/updateOrgRuleset.md b/docs/repos/updateOrgRuleset.md index b444865ef..8272b9838 100644 --- a/docs/repos/updateOrgRuleset.md +++ b/docs/repos/updateOrgRuleset.md @@ -1,6 +1,6 @@ --- name: Update an organization repository ruleset -example: octokit.rest.repos.updateOrgRuleset({ org, ruleset_id, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.updateOrgRuleset({ org, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) route: PUT /orgs/{org}/rulesets/{ruleset_id} scope: repos type: API method @@ -14,6 +14,9 @@ Update a ruleset for an organization. octokit.rest.repos.updateOrgRuleset({ org, ruleset_id, +bypass_actors[].actor_id, +bypass_actors[].actor_type, +bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, @@ -71,19 +74,24 @@ The enforcement level of the ruleset. `evaluate` allows admins to test rules bef The actors that can bypass the rules in this ruleset -bypass_actors[].actor_idno +bypass_actors[].actor_idyes The ID of the actor that can bypass a ruleset -bypass_actors[].actor_typeno +bypass_actors[].actor_typeyes The type of actor that can bypass a ruleset + +bypass_actors[].bypass_modeyes + +When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + conditionsno -Conditions for a organization ruleset +Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. rulesno @@ -175,4 +183,4 @@ The pattern to match with. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#update-organization-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset). diff --git a/docs/repos/updateRelease.md b/docs/repos/updateRelease.md index c4e22cca5..869e4929a 100644 --- a/docs/repos/updateRelease.md +++ b/docs/repos/updateRelease.md @@ -87,4 +87,4 @@ If specified, a discussion of the specified category is created and linked to th -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-a-release). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/releases#update-a-release). diff --git a/docs/repos/updateReleaseAsset.md b/docs/repos/updateReleaseAsset.md index eea3e1575..d80f9407a 100644 --- a/docs/repos/updateReleaseAsset.md +++ b/docs/repos/updateReleaseAsset.md @@ -60,4 +60,4 @@ An alternate short description of the asset. Used in place of the filename. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#update-a-release-asset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/assets#update-a-release-asset). diff --git a/docs/repos/updateRepoRuleset.md b/docs/repos/updateRepoRuleset.md index 8bc728f0f..8de9b887e 100644 --- a/docs/repos/updateRepoRuleset.md +++ b/docs/repos/updateRepoRuleset.md @@ -1,6 +1,6 @@ --- name: Update a repository ruleset -example: octokit.rest.repos.updateRepoRuleset({ owner, repo, ruleset_id, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) +example: octokit.rest.repos.updateRepoRuleset({ owner, repo, ruleset_id, bypass_actors[].actor_id, bypass_actors[].actor_type, bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, rules[].parameters.dismiss_stale_reviews_on_push, rules[].parameters.require_code_owner_review, rules[].parameters.require_last_push_approval, rules[].parameters.required_approving_review_count, rules[].parameters.required_review_thread_resolution, rules[].parameters.required_status_checks, rules[].parameters.required_status_checks[].context, rules[].parameters.strict_required_status_checks_policy, rules[].parameters.operator, rules[].parameters.pattern }) route: PUT /repos/{owner}/{repo}/rulesets/{ruleset_id} scope: repos type: API method @@ -15,6 +15,9 @@ octokit.rest.repos.updateRepoRuleset({ owner, repo, ruleset_id, +bypass_actors[].actor_id, +bypass_actors[].actor_type, +bypass_actors[].bypass_mode, rules[].type, rules[].parameters.update_allows_fetch_and_merge, rules[].parameters.required_deployment_environments, @@ -71,26 +74,26 @@ The target of the ruleset. The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - -bypass_modeno - -The permission level required to bypass this ruleset. "repository" allows those with bypass permission at the repository level to bypass. "organization" allows those with bypass permission at the organization level to bypass. "none" prevents anyone from bypassing. - bypass_actorsno The actors that can bypass the rules in this ruleset -bypass_actors[].actor_idno +bypass_actors[].actor_idyes The ID of the actor that can bypass a ruleset -bypass_actors[].actor_typeno +bypass_actors[].actor_typeyes The type of actor that can bypass a ruleset + +bypass_actors[].bypass_modeyes + +When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + conditionsno @@ -199,4 +202,4 @@ The pattern to match with. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#update-repository-ruleset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/repos/rules#update-a-repository-ruleset). diff --git a/docs/repos/updateWebhook.md b/docs/repos/updateWebhook.md index f178e90d2..54a8df5ba 100644 --- a/docs/repos/updateWebhook.md +++ b/docs/repos/updateWebhook.md @@ -8,7 +8,7 @@ type: API method # Update a repository webhook -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)." +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/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." ```js octokit.rest.repos.updateWebhook({ @@ -47,7 +47,7 @@ The unique identifier of the hook. configno -Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params). +Key/value pairs to provide settings for this webhook. config.urlyes diff --git a/docs/repos/updateWebhookConfigForRepo.md b/docs/repos/updateWebhookConfigForRepo.md index 319123381..d1c0c0894 100644 --- a/docs/repos/updateWebhookConfigForRepo.md +++ b/docs/repos/updateWebhookConfigForRepo.md @@ -8,7 +8,7 @@ type: API method # Update a webhook configuration for a repository -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)." +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/webhooks/repos#update-a-repository-webhook)." Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. diff --git a/docs/repos/uploadReleaseAsset.md b/docs/repos/uploadReleaseAsset.md index 38cad2b4a..a7f27752e 100644 --- a/docs/repos/uploadReleaseAsset.md +++ b/docs/repos/uploadReleaseAsset.md @@ -24,7 +24,7 @@ When an upstream failure occurs, you will receive a `502 Bad Gateway` status. Th **Notes:** -- 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)" +- GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). - 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. @@ -84,4 +84,4 @@ The URL origin (protocol + host name + port) is included in `upload_url` returne -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/repos#upload-a-release-asset). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/releases/assets#upload-a-release-asset). diff --git a/docs/search/code.md b/docs/search/code.md index 0975eb74b..3724c705f 100644 --- a/docs/search/code.md +++ b/docs/search/code.md @@ -10,7 +10,7 @@ type: API method 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). -When 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). +When 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/search/search#text-match-metadata). For 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: @@ -18,7 +18,7 @@ For example, if you want to find the definition of the `addClass` function insid This 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. -#### Considerations for code search +Considerations for code search: Due to the complexity of searching code, there are a few restrictions on how searches are performed: @@ -48,12 +48,12 @@ octokit.rest.search.code({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. sortno -**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -74,4 +74,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-code). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-code). diff --git a/docs/search/commits.md b/docs/search/commits.md index e2858acfd..9b6d552f2 100644 --- a/docs/search/commits.md +++ b/docs/search/commits.md @@ -11,7 +11,7 @@ type: API method Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). When 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 -metadata](https://docs.github.com/rest/reference/search#text-match-metadata). +metadata](https://docs.github.com/rest/search/search#text-match-metadata). For 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: @@ -36,12 +36,12 @@ octokit.rest.search.commits({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. sortno -Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -62,4 +62,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-commits). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-commits). diff --git a/docs/search/issuesAndPullRequests.md b/docs/search/issuesAndPullRequests.md index 2c89cc098..4aefe5605 100644 --- a/docs/search/issuesAndPullRequests.md +++ b/docs/search/issuesAndPullRequests.md @@ -11,7 +11,7 @@ type: API method 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). When 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 -search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). +search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. @@ -19,7 +19,7 @@ For example, if you want to find the oldest unresolved Python bugs on Windows. Y This 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. -**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)." +**Note:** For requests made by GitHub Apps with a user access token, 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)." ```js octokit.rest.search.issuesAndPullRequests({ @@ -40,12 +40,12 @@ octokit.rest.search.issuesAndPullRequests({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. sortno -Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -66,4 +66,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-issues-and-pull-requests). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-issues-and-pull-requests). diff --git a/docs/search/labels.md b/docs/search/labels.md index 36276b50c..210d49680 100644 --- a/docs/search/labels.md +++ b/docs/search/labels.md @@ -10,7 +10,7 @@ type: API method 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). -When 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). +When 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/search/search#text-match-metadata). For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: @@ -43,12 +43,12 @@ The id of the repository. qyes -The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). +The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). sortno -Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -69,4 +69,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-labels). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-labels). diff --git a/docs/search/repos.md b/docs/search/repos.md index aa654395d..7df4cc1d9 100644 --- a/docs/search/repos.md +++ b/docs/search/repos.md @@ -10,7 +10,7 @@ type: API method 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). -When 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). +When 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/search/search#text-match-metadata). For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: @@ -37,12 +37,12 @@ octokit.rest.search.repos({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. sortno -Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -63,4 +63,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-repositories). diff --git a/docs/search/topics.md b/docs/search/topics.md index 7d3b9335d..c99705237 100644 --- a/docs/search/topics.md +++ b/docs/search/topics.md @@ -10,7 +10,7 @@ type: API method 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://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. -When 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). +When 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/search/search#text-match-metadata). For 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: @@ -37,7 +37,7 @@ octokit.rest.search.topics({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). per_pageno @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-topics). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-topics). diff --git a/docs/search/users.md b/docs/search/users.md index 1d68e5263..7756ad311 100644 --- a/docs/search/users.md +++ b/docs/search/users.md @@ -10,7 +10,7 @@ type: API method 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). -When searching for users, you can get text match metadata for the issue **login**, public **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). +When searching for users, you can get text match metadata for the issue **login**, public **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/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For example, if you're looking for a list of popular users, you might try this query: @@ -18,6 +18,8 @@ For example, if you're looking for a list of popular users, you might try this q This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. +This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." + ```js octokit.rest.search.users({ q, @@ -37,12 +39,12 @@ octokit.rest.search.users({ qyes -The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. +The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. sortno -Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results) +Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) orderno @@ -63,4 +65,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/search#search-users). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/search/search#search-users). diff --git a/docs/secretScanning/getAlert.md b/docs/secretScanning/getAlert.md index 2e5ade7b5..0fa006965 100644 --- a/docs/secretScanning/getAlert.md +++ b/docs/secretScanning/getAlert.md @@ -51,4 +51,4 @@ The number that identifies an alert. You can find this at the end of the URL for -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#get-a-secret-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert). diff --git a/docs/secretScanning/listAlertsForEnterprise.md b/docs/secretScanning/listAlertsForEnterprise.md index d6437f2d8..f78f923cb 100644 --- a/docs/secretScanning/listAlertsForEnterprise.md +++ b/docs/secretScanning/listAlertsForEnterprise.md @@ -78,4 +78,4 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise). diff --git a/docs/secretScanning/listAlertsForOrg.md b/docs/secretScanning/listAlertsForOrg.md index 3f320ce7a..888383cd2 100644 --- a/docs/secretScanning/listAlertsForOrg.md +++ b/docs/secretScanning/listAlertsForOrg.md @@ -86,4 +86,4 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization). diff --git a/docs/secretScanning/listAlertsForRepo.md b/docs/secretScanning/listAlertsForRepo.md index adb713bc3..6d9fbccd8 100644 --- a/docs/secretScanning/listAlertsForRepo.md +++ b/docs/secretScanning/listAlertsForRepo.md @@ -92,4 +92,4 @@ A cursor, as given in the [Link header](https://docs.github.com/rest/guides/usin -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository). diff --git a/docs/secretScanning/listLocationsForAlert.md b/docs/secretScanning/listLocationsForAlert.md index d365df3b6..7b9443a68 100644 --- a/docs/secretScanning/listLocationsForAlert.md +++ b/docs/secretScanning/listLocationsForAlert.md @@ -61,4 +61,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert). diff --git a/docs/secretScanning/updateAlert.md b/docs/secretScanning/updateAlert.md index 011104fdd..751bca9e5 100644 --- a/docs/secretScanning/updateAlert.md +++ b/docs/secretScanning/updateAlert.md @@ -67,4 +67,4 @@ An optional comment when closing an alert. Cannot be updated or deleted. Must be -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/secret-scanning#update-a-secret-scanning-alert). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert). diff --git a/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md b/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md new file mode 100644 index 000000000..c6de652f4 --- /dev/null +++ b/docs/securityAdvisories/createRepositoryAdvisoryCveRequest.md @@ -0,0 +1,56 @@ +--- +name: Request a CVE for a repository security advisory +example: octokit.rest.securityAdvisories.createRepositoryAdvisoryCveRequest({ owner, repo, ghsa_id }) +route: POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve +scope: securityAdvisories +type: API method +--- + +# Request a CVE for a repository security advisory + +If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + +You may request a CVE for public repositories, but cannot do so for private repositories. + +You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + +In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + +```js +octokit.rest.securityAdvisories.createRepositoryAdvisoryCveRequest({ + owner, + repo, + ghsa_id, +}); +``` + +## Parameters + + + + + + + + + + + + + + +
namerequireddescription
owneryes + +The account owner of the repository. The name is not case sensitive. + +
repoyes + +The name of the repository without the `.git` extension. The name is not case sensitive. + +
ghsa_idyes + +The GHSA (GitHub Security Advisory) identifier of the advisory. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory). diff --git a/docs/securityAdvisories/getGlobalAdvisory.md b/docs/securityAdvisories/getGlobalAdvisory.md new file mode 100644 index 000000000..c302b830b --- /dev/null +++ b/docs/securityAdvisories/getGlobalAdvisory.md @@ -0,0 +1,38 @@ +--- +name: Get a global security advisory +example: octokit.rest.securityAdvisories.getGlobalAdvisory({ ghsa_id }) +route: GET /advisories/{ghsa_id} +scope: securityAdvisories +type: API method +--- + +# Get a global security advisory + +Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + +```js +octokit.rest.securityAdvisories.getGlobalAdvisory({ + ghsa_id, +}); +``` + +## Parameters + + + + + + + + + + + + +
namerequireddescription
ghsa_idyes + +The GHSA (GitHub Security Advisory) identifier of the advisory. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory). diff --git a/docs/securityAdvisories/listGlobalAdvisories.md b/docs/securityAdvisories/listGlobalAdvisories.md new file mode 100644 index 000000000..7b2f71f79 --- /dev/null +++ b/docs/securityAdvisories/listGlobalAdvisories.md @@ -0,0 +1,124 @@ +--- +name: List global security advisories +example: octokit.rest.securityAdvisories.listGlobalAdvisories() +route: GET /advisories +scope: securityAdvisories +type: API method +--- + +# List global security advisories + +Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + +By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + +```js +octokit.rest.securityAdvisories.listGlobalAdvisories(); +``` + +## Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + +
namerequireddescription
ghsa_idno + +If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. + +
typeno + +If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. + +
cve_idno + +If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. + +
ecosystemno + +If specified, only advisories for these ecosystems will be returned. + +
severityno + +If specified, only advisories with these severities will be returned. + +
cwesno + +If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + +Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` + +
is_withdrawnno + +Whether to only return advisories that have been withdrawn. + +
affectsno + +If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. +If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + +Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + +
publishedno + +If specified, only return advisories that were published on a date or date range. + +For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + +
updatedno + +If specified, only return advisories that were updated on a date or date range. + +For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + +
modifiedno + +If specified, only show advisories that were updated or published on a date or date range. + +For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." + +
beforeno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. + +
afterno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. + +
directionno + +The direction to sort the results by. + +
per_pageno + +The number of results per page (max 100). + +
sortno + +The property to sort the results by. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories). diff --git a/docs/securityAdvisories/listOrgRepositoryAdvisories.md b/docs/securityAdvisories/listOrgRepositoryAdvisories.md new file mode 100644 index 000000000..6f6093eed --- /dev/null +++ b/docs/securityAdvisories/listOrgRepositoryAdvisories.md @@ -0,0 +1,70 @@ +--- +name: List repository security advisories for an organization +example: octokit.rest.securityAdvisories.listOrgRepositoryAdvisories({ org }) +route: GET /orgs/{org}/security-advisories +scope: securityAdvisories +type: API method +--- + +# List repository security advisories for an organization + +Lists repository security advisories for an organization. + +To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + +```js +octokit.rest.securityAdvisories.listOrgRepositoryAdvisories({ + org, +}); +``` + +## Parameters + + + + + + + + + + + + + + + + + + +
namerequireddescription
orgyes + +The organization name. The name is not case sensitive. + +
directionno + +The direction to sort the results by. + +
sortno + +The property to sort the results by. + +
beforeno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. + +
afterno + +A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. + +
per_pageno + +The number of advisories to return per page. + +
stateno + +Filter by the state of the repository advisories. Only advisories of this state will be returned. + +
+ +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization). diff --git a/docs/securityAdvisories/updateRepositoryAdvisory.md b/docs/securityAdvisories/updateRepositoryAdvisory.md index 4d7759c25..01dfe4049 100644 --- a/docs/securityAdvisories/updateRepositoryAdvisory.md +++ b/docs/securityAdvisories/updateRepositoryAdvisory.md @@ -136,6 +136,16 @@ The CVSS vector that calculates the severity of the advisory. You must choose be The state of the advisory. + +collaborating_usersno + +A list of usernames who have been granted write access to the advisory. + + +collaborating_teamsno + +A list of team slugs which have been granted write access to the advisory. + diff --git a/docs/teams/addOrUpdateMembershipForUserInOrg.md b/docs/teams/addOrUpdateMembershipForUserInOrg.md index 154617780..6cbf5ff79 100644 --- a/docs/teams/addOrUpdateMembershipForUserInOrg.md +++ b/docs/teams/addOrUpdateMembershipForUserInOrg.md @@ -62,4 +62,4 @@ The role that this user should have in the team. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user). diff --git a/docs/teams/addOrUpdateProjectPermissionsInOrg.md b/docs/teams/addOrUpdateProjectPermissionsInOrg.md index 5e85a2297..3ae5db05e 100644 --- a/docs/teams/addOrUpdateProjectPermissionsInOrg.md +++ b/docs/teams/addOrUpdateProjectPermissionsInOrg.md @@ -54,4 +54,4 @@ The permission to grant to the team for this project. Default: the team's `permi -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions). diff --git a/docs/teams/addOrUpdateRepoPermissionsInOrg.md b/docs/teams/addOrUpdateRepoPermissionsInOrg.md index 44de5955c..2ce5a8cb8 100644 --- a/docs/teams/addOrUpdateRepoPermissionsInOrg.md +++ b/docs/teams/addOrUpdateRepoPermissionsInOrg.md @@ -62,4 +62,4 @@ The permission to grant the team on this repository. We accept the following per -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions). diff --git a/docs/teams/checkPermissionsForProjectInOrg.md b/docs/teams/checkPermissionsForProjectInOrg.md index 72f88185e..89c89ecea 100644 --- a/docs/teams/checkPermissionsForProjectInOrg.md +++ b/docs/teams/checkPermissionsForProjectInOrg.md @@ -49,4 +49,4 @@ The unique identifier of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-project). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project). diff --git a/docs/teams/checkPermissionsForRepoInOrg.md b/docs/teams/checkPermissionsForRepoInOrg.md index f083a6797..274426cba 100644 --- a/docs/teams/checkPermissionsForRepoInOrg.md +++ b/docs/teams/checkPermissionsForRepoInOrg.md @@ -59,4 +59,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams/#check-team-permissions-for-a-repository). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository). diff --git a/docs/teams/create.md b/docs/teams/create.md index 1f880f3ee..6d5db4757 100644 --- a/docs/teams/create.md +++ b/docs/teams/create.md @@ -90,4 +90,4 @@ The ID of a team to set as the parent team. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#create-a-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#create-a-team). diff --git a/docs/teams/createDiscussionCommentInOrg.md b/docs/teams/createDiscussionCommentInOrg.md index db6108f38..a610bdc5c 100644 --- a/docs/teams/createDiscussionCommentInOrg.md +++ b/docs/teams/createDiscussionCommentInOrg.md @@ -57,4 +57,4 @@ The discussion comment's body text. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#create-a-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment). diff --git a/docs/teams/createDiscussionInOrg.md b/docs/teams/createDiscussionInOrg.md index 4e8f825f7..0fe384891 100644 --- a/docs/teams/createDiscussionInOrg.md +++ b/docs/teams/createDiscussionInOrg.md @@ -62,4 +62,4 @@ Private posts are only visible to team members, organization owners, and team ma -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#create-a-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussions#create-a-discussion). diff --git a/docs/teams/deleteDiscussionCommentInOrg.md b/docs/teams/deleteDiscussionCommentInOrg.md index af0b5a03a..fe4085a4d 100644 --- a/docs/teams/deleteDiscussionCommentInOrg.md +++ b/docs/teams/deleteDiscussionCommentInOrg.md @@ -55,4 +55,4 @@ The number that identifies the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#delete-a-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment). diff --git a/docs/teams/deleteDiscussionInOrg.md b/docs/teams/deleteDiscussionInOrg.md index cfa611617..d433afed7 100644 --- a/docs/teams/deleteDiscussionInOrg.md +++ b/docs/teams/deleteDiscussionInOrg.md @@ -49,4 +49,4 @@ The number that identifies the discussion. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#delete-a-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussions#delete-a-discussion). diff --git a/docs/teams/deleteInOrg.md b/docs/teams/deleteInOrg.md index ba6188b28..32931948b 100644 --- a/docs/teams/deleteInOrg.md +++ b/docs/teams/deleteInOrg.md @@ -45,4 +45,4 @@ The slug of the team name. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#delete-a-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#delete-a-team). diff --git a/docs/teams/getByName.md b/docs/teams/getByName.md index 07a802a48..0408e5141 100644 --- a/docs/teams/getByName.md +++ b/docs/teams/getByName.md @@ -43,4 +43,4 @@ The slug of the team name. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#get-a-team-by-name). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#get-a-team-by-name). diff --git a/docs/teams/getDiscussionCommentInOrg.md b/docs/teams/getDiscussionCommentInOrg.md index 3051a7afe..a8b75f1b0 100644 --- a/docs/teams/getDiscussionCommentInOrg.md +++ b/docs/teams/getDiscussionCommentInOrg.md @@ -55,4 +55,4 @@ The number that identifies the comment. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#get-a-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). diff --git a/docs/teams/getDiscussionInOrg.md b/docs/teams/getDiscussionInOrg.md index 6960d8b49..a9ff8f017 100644 --- a/docs/teams/getDiscussionInOrg.md +++ b/docs/teams/getDiscussionInOrg.md @@ -49,4 +49,4 @@ The number that identifies the discussion. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#get-a-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussions#get-a-discussion). diff --git a/docs/teams/getMembershipForUserInOrg.md b/docs/teams/getMembershipForUserInOrg.md index 63e1ce7c4..1ab5e0888 100644 --- a/docs/teams/getMembershipForUserInOrg.md +++ b/docs/teams/getMembershipForUserInOrg.md @@ -17,7 +17,7 @@ To get a user's membership with a team, the team must be visible to the authenti **Note:** The response contains the `state` of the membership and the member's `role`. -The `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). +The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). ```js octokit.rest.teams.getMembershipForUserInOrg({ @@ -56,4 +56,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#get-team-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user). diff --git a/docs/teams/list.md b/docs/teams/list.md index 842a8cf19..e97b4a41d 100644 --- a/docs/teams/list.md +++ b/docs/teams/list.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-teams). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#list-teams). diff --git a/docs/teams/listChildInOrg.md b/docs/teams/listChildInOrg.md index 055dea78e..729af6f1d 100644 --- a/docs/teams/listChildInOrg.md +++ b/docs/teams/listChildInOrg.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-child-teams). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#list-child-teams). diff --git a/docs/teams/listDiscussionCommentsInOrg.md b/docs/teams/listDiscussionCommentsInOrg.md index 4ad381a05..d38c228b8 100644 --- a/docs/teams/listDiscussionCommentsInOrg.md +++ b/docs/teams/listDiscussionCommentsInOrg.md @@ -64,4 +64,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-discussion-comments). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments). diff --git a/docs/teams/listDiscussionsInOrg.md b/docs/teams/listDiscussionsInOrg.md index 9127dd1e9..95b8df5d4 100644 --- a/docs/teams/listDiscussionsInOrg.md +++ b/docs/teams/listDiscussionsInOrg.md @@ -63,4 +63,4 @@ Pinned discussions only filter -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-discussions). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussions#list-discussions). diff --git a/docs/teams/listForAuthenticatedUser.md b/docs/teams/listForAuthenticatedUser.md index 6504c42b4..c5229d6e3 100644 --- a/docs/teams/listForAuthenticatedUser.md +++ b/docs/teams/listForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user). diff --git a/docs/teams/listMembersInOrg.md b/docs/teams/listMembersInOrg.md index 0cf8ae16b..fd1519c91 100644 --- a/docs/teams/listMembersInOrg.md +++ b/docs/teams/listMembersInOrg.md @@ -58,4 +58,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-team-members). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/members#list-team-members). diff --git a/docs/teams/listPendingInvitationsInOrg.md b/docs/teams/listPendingInvitationsInOrg.md index c65f8947c..20a4386d9 100644 --- a/docs/teams/listPendingInvitationsInOrg.md +++ b/docs/teams/listPendingInvitationsInOrg.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-pending-team-invitations). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/members#list-pending-team-invitations). diff --git a/docs/teams/listProjectsInOrg.md b/docs/teams/listProjectsInOrg.md index 69c355bf4..3ca20368d 100644 --- a/docs/teams/listProjectsInOrg.md +++ b/docs/teams/listProjectsInOrg.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-team-projects). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#list-team-projects). diff --git a/docs/teams/listReposInOrg.md b/docs/teams/listReposInOrg.md index 3250ba415..6c6c82afb 100644 --- a/docs/teams/listReposInOrg.md +++ b/docs/teams/listReposInOrg.md @@ -53,4 +53,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#list-team-repositories). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#list-team-repositories). diff --git a/docs/teams/removeMembershipForUserInOrg.md b/docs/teams/removeMembershipForUserInOrg.md index 0a645e087..90abbd4cb 100644 --- a/docs/teams/removeMembershipForUserInOrg.md +++ b/docs/teams/removeMembershipForUserInOrg.md @@ -53,4 +53,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user). diff --git a/docs/teams/removeProjectInOrg.md b/docs/teams/removeProjectInOrg.md index b836a84ca..ff9c15126 100644 --- a/docs/teams/removeProjectInOrg.md +++ b/docs/teams/removeProjectInOrg.md @@ -49,4 +49,4 @@ The unique identifier of the project. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#remove-a-project-from-a-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team). diff --git a/docs/teams/removeRepoInOrg.md b/docs/teams/removeRepoInOrg.md index b5564b7fe..1aef40fbc 100644 --- a/docs/teams/removeRepoInOrg.md +++ b/docs/teams/removeRepoInOrg.md @@ -55,4 +55,4 @@ The name of the repository without the `.git` extension. The name is not case se -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams/#remove-a-repository-from-a-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team). diff --git a/docs/teams/updateDiscussionCommentInOrg.md b/docs/teams/updateDiscussionCommentInOrg.md index ab73f3e5a..928b5dbf9 100644 --- a/docs/teams/updateDiscussionCommentInOrg.md +++ b/docs/teams/updateDiscussionCommentInOrg.md @@ -61,4 +61,4 @@ The discussion comment's body text. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#update-a-discussion-comment). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment). diff --git a/docs/teams/updateDiscussionInOrg.md b/docs/teams/updateDiscussionInOrg.md index 46ba14743..263ead104 100644 --- a/docs/teams/updateDiscussionInOrg.md +++ b/docs/teams/updateDiscussionInOrg.md @@ -59,4 +59,4 @@ The discussion post's body text. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#update-a-discussion). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/discussions#update-a-discussion). diff --git a/docs/teams/updateInOrg.md b/docs/teams/updateInOrg.md index fb718b140..f59c5324b 100644 --- a/docs/teams/updateInOrg.md +++ b/docs/teams/updateInOrg.md @@ -82,4 +82,4 @@ The ID of a team to set as the parent team. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/teams#update-a-team). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/teams/teams#update-a-team). diff --git a/docs/users/addEmailForAuthenticated.md b/docs/users/addEmailForAuthenticated.md index 65e859685..75147ab3d 100644 --- a/docs/users/addEmailForAuthenticated.md +++ b/docs/users/addEmailForAuthenticated.md @@ -37,4 +37,4 @@ Adds one or more email addresses to your GitHub account. Must contain at least o -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user). diff --git a/docs/users/addEmailForAuthenticatedUser.md b/docs/users/addEmailForAuthenticatedUser.md index 3c8271146..d65d80d99 100644 --- a/docs/users/addEmailForAuthenticatedUser.md +++ b/docs/users/addEmailForAuthenticatedUser.md @@ -35,4 +35,4 @@ Adds one or more email addresses to your GitHub account. Must contain at least o -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user). diff --git a/docs/users/addSocialAccountForAuthenticatedUser.md b/docs/users/addSocialAccountForAuthenticatedUser.md index ff73bcd05..5c3ef149e 100644 --- a/docs/users/addSocialAccountForAuthenticatedUser.md +++ b/docs/users/addSocialAccountForAuthenticatedUser.md @@ -35,4 +35,4 @@ Full URLs for the social media profiles to add. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/social-accounts#add-social-account-for-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user). diff --git a/docs/users/block.md b/docs/users/block.md index b5c48d0ad..1c7b5e97c 100644 --- a/docs/users/block.md +++ b/docs/users/block.md @@ -8,6 +8,8 @@ type: API method # Block a user +Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. + ```js octokit.rest.users.block({ username, @@ -33,4 +35,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#block-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/blocking#block-a-user). diff --git a/docs/users/checkBlocked.md b/docs/users/checkBlocked.md index fd6c5065d..d6102c36a 100644 --- a/docs/users/checkBlocked.md +++ b/docs/users/checkBlocked.md @@ -8,6 +8,8 @@ type: API method # Check if a user is blocked by the authenticated user +Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. + ```js octokit.rest.users.checkBlocked({ username, @@ -33,4 +35,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user). diff --git a/docs/users/checkFollowingForUser.md b/docs/users/checkFollowingForUser.md index 462410255..dc40ffd19 100644 --- a/docs/users/checkFollowingForUser.md +++ b/docs/users/checkFollowingForUser.md @@ -37,4 +37,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user). diff --git a/docs/users/checkPersonIsFollowedByAuthenticated.md b/docs/users/checkPersonIsFollowedByAuthenticated.md index 6660d89d9..42a2c54b9 100644 --- a/docs/users/checkPersonIsFollowedByAuthenticated.md +++ b/docs/users/checkPersonIsFollowedByAuthenticated.md @@ -33,4 +33,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user). diff --git a/docs/users/createGpgKeyForAuthenticated.md b/docs/users/createGpgKeyForAuthenticated.md index 4f2622be6..26bb1009b 100644 --- a/docs/users/createGpgKeyForAuthenticated.md +++ b/docs/users/createGpgKeyForAuthenticated.md @@ -42,4 +42,4 @@ A GPG key in ASCII-armored format. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/createGpgKeyForAuthenticatedUser.md b/docs/users/createGpgKeyForAuthenticatedUser.md index 767abfb30..c03cfc303 100644 --- a/docs/users/createGpgKeyForAuthenticatedUser.md +++ b/docs/users/createGpgKeyForAuthenticatedUser.md @@ -40,4 +40,4 @@ A GPG key in ASCII-armored format. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/createPublicSshKeyForAuthenticated.md b/docs/users/createPublicSshKeyForAuthenticated.md index a6444bff1..83de8c446 100644 --- a/docs/users/createPublicSshKeyForAuthenticated.md +++ b/docs/users/createPublicSshKeyForAuthenticated.md @@ -42,4 +42,4 @@ The public SSH key to add to your GitHub account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/createPublicSshKeyForAuthenticatedUser.md b/docs/users/createPublicSshKeyForAuthenticatedUser.md index 3007e0347..839575da1 100644 --- a/docs/users/createPublicSshKeyForAuthenticatedUser.md +++ b/docs/users/createPublicSshKeyForAuthenticatedUser.md @@ -40,4 +40,4 @@ The public SSH key to add to your GitHub account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/createSshSigningKeyForAuthenticatedUser.md b/docs/users/createSshSigningKeyForAuthenticatedUser.md index 966914cfa..0d43956a1 100644 --- a/docs/users/createSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/createSshSigningKeyForAuthenticatedUser.md @@ -40,4 +40,4 @@ The public SSH key to add to your GitHub account. For more information, see "[Ch -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user). diff --git a/docs/users/deleteEmailForAuthenticated.md b/docs/users/deleteEmailForAuthenticated.md index e563402bf..5db873b93 100644 --- a/docs/users/deleteEmailForAuthenticated.md +++ b/docs/users/deleteEmailForAuthenticated.md @@ -37,4 +37,4 @@ Email addresses associated with the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user). diff --git a/docs/users/deleteEmailForAuthenticatedUser.md b/docs/users/deleteEmailForAuthenticatedUser.md index 67578d46e..54b5915b9 100644 --- a/docs/users/deleteEmailForAuthenticatedUser.md +++ b/docs/users/deleteEmailForAuthenticatedUser.md @@ -35,4 +35,4 @@ Email addresses associated with the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user). diff --git a/docs/users/deleteGpgKeyForAuthenticated.md b/docs/users/deleteGpgKeyForAuthenticated.md index 630db850e..988fbc10b 100644 --- a/docs/users/deleteGpgKeyForAuthenticated.md +++ b/docs/users/deleteGpgKeyForAuthenticated.md @@ -37,4 +37,4 @@ The unique identifier of the GPG key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/deleteGpgKeyForAuthenticatedUser.md b/docs/users/deleteGpgKeyForAuthenticatedUser.md index 3ee70efd8..c4d9bf129 100644 --- a/docs/users/deleteGpgKeyForAuthenticatedUser.md +++ b/docs/users/deleteGpgKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the GPG key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/deletePublicSshKeyForAuthenticated.md b/docs/users/deletePublicSshKeyForAuthenticated.md index 1100e4469..a53f9f9ee 100644 --- a/docs/users/deletePublicSshKeyForAuthenticated.md +++ b/docs/users/deletePublicSshKeyForAuthenticated.md @@ -37,4 +37,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/deletePublicSshKeyForAuthenticatedUser.md b/docs/users/deletePublicSshKeyForAuthenticatedUser.md index eeec96777..9db435266 100644 --- a/docs/users/deletePublicSshKeyForAuthenticatedUser.md +++ b/docs/users/deletePublicSshKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/deleteSocialAccountForAuthenticatedUser.md b/docs/users/deleteSocialAccountForAuthenticatedUser.md index 86b8a8411..04b052c62 100644 --- a/docs/users/deleteSocialAccountForAuthenticatedUser.md +++ b/docs/users/deleteSocialAccountForAuthenticatedUser.md @@ -35,4 +35,4 @@ Full URLs for the social media profiles to delete. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/social-accounts#delete-social-account-for-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user). diff --git a/docs/users/deleteSshSigningKeyForAuthenticatedUser.md b/docs/users/deleteSshSigningKeyForAuthenticatedUser.md index a08140875..ae529a215 100644 --- a/docs/users/deleteSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/deleteSshSigningKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the SSH signing key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user). diff --git a/docs/users/follow.md b/docs/users/follow.md index d38199354..01e9e4812 100644 --- a/docs/users/follow.md +++ b/docs/users/follow.md @@ -37,4 +37,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#follow-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#follow-a-user). diff --git a/docs/users/getAuthenticated.md b/docs/users/getAuthenticated.md index b989623a4..98f720b99 100644 --- a/docs/users/getAuthenticated.md +++ b/docs/users/getAuthenticated.md @@ -20,4 +20,4 @@ octokit.rest.users.getAuthenticated(); This endpoint has no parameters -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/users#get-the-authenticated-user). diff --git a/docs/users/getByUsername.md b/docs/users/getByUsername.md index d3816d05a..c2e243702 100644 --- a/docs/users/getByUsername.md +++ b/docs/users/getByUsername.md @@ -14,7 +14,7 @@ GitHub Apps with the `Plan` user permission can use this endpoint to retrieve in The `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). -The 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)". +The 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/users/emails)". ```js octokit.rest.users.getByUsername({ @@ -41,4 +41,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/users#get-a-user). diff --git a/docs/users/getContextForUser.md b/docs/users/getContextForUser.md index 993888069..1856860ff 100644 --- a/docs/users/getContextForUser.md +++ b/docs/users/getContextForUser.md @@ -52,4 +52,4 @@ Uses the ID for the `subject_type` you specified. **Required** when using `subje -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-contextual-information-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/users#get-contextual-information-for-a-user). diff --git a/docs/users/getGpgKeyForAuthenticated.md b/docs/users/getGpgKeyForAuthenticated.md index 75c724f73..2b1de7114 100644 --- a/docs/users/getGpgKeyForAuthenticated.md +++ b/docs/users/getGpgKeyForAuthenticated.md @@ -37,4 +37,4 @@ The unique identifier of the GPG key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/getGpgKeyForAuthenticatedUser.md b/docs/users/getGpgKeyForAuthenticatedUser.md index 745a41cce..4ace4a5ec 100644 --- a/docs/users/getGpgKeyForAuthenticatedUser.md +++ b/docs/users/getGpgKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the GPG key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user). diff --git a/docs/users/getPublicSshKeyForAuthenticated.md b/docs/users/getPublicSshKeyForAuthenticated.md index 6a4617573..3ac11a39a 100644 --- a/docs/users/getPublicSshKeyForAuthenticated.md +++ b/docs/users/getPublicSshKeyForAuthenticated.md @@ -37,4 +37,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/getPublicSshKeyForAuthenticatedUser.md b/docs/users/getPublicSshKeyForAuthenticatedUser.md index 76d0386ae..09eaec814 100644 --- a/docs/users/getPublicSshKeyForAuthenticatedUser.md +++ b/docs/users/getPublicSshKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user). diff --git a/docs/users/getSshSigningKeyForAuthenticatedUser.md b/docs/users/getSshSigningKeyForAuthenticatedUser.md index e3c41b2fa..4f22e0b59 100644 --- a/docs/users/getSshSigningKeyForAuthenticatedUser.md +++ b/docs/users/getSshSigningKeyForAuthenticatedUser.md @@ -35,4 +35,4 @@ The unique identifier of the SSH signing key. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user). diff --git a/docs/users/list.md b/docs/users/list.md index 1c18c196f..c2f99753a 100644 --- a/docs/users/list.md +++ b/docs/users/list.md @@ -40,4 +40,4 @@ The number of results per page (max 100). -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/users#list-users). diff --git a/docs/users/listBlockedByAuthenticated.md b/docs/users/listBlockedByAuthenticated.md index 045fcceb4..0f4aeff33 100644 --- a/docs/users/listBlockedByAuthenticated.md +++ b/docs/users/listBlockedByAuthenticated.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user). diff --git a/docs/users/listBlockedByAuthenticatedUser.md b/docs/users/listBlockedByAuthenticatedUser.md index 0c592f98c..7fd700ff0 100644 --- a/docs/users/listBlockedByAuthenticatedUser.md +++ b/docs/users/listBlockedByAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user). diff --git a/docs/users/listEmailsForAuthenticated.md b/docs/users/listEmailsForAuthenticated.md index 783c39265..14668542a 100644 --- a/docs/users/listEmailsForAuthenticated.md +++ b/docs/users/listEmailsForAuthenticated.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user). diff --git a/docs/users/listEmailsForAuthenticatedUser.md b/docs/users/listEmailsForAuthenticatedUser.md index 171ebee16..242954687 100644 --- a/docs/users/listEmailsForAuthenticatedUser.md +++ b/docs/users/listEmailsForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user). diff --git a/docs/users/listFollowedByAuthenticated.md b/docs/users/listFollowedByAuthenticated.md index 25a0099c6..3d7286ec8 100644 --- a/docs/users/listFollowedByAuthenticated.md +++ b/docs/users/listFollowedByAuthenticated.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows). diff --git a/docs/users/listFollowedByAuthenticatedUser.md b/docs/users/listFollowedByAuthenticatedUser.md index 2a630952f..564633e5b 100644 --- a/docs/users/listFollowedByAuthenticatedUser.md +++ b/docs/users/listFollowedByAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows). diff --git a/docs/users/listFollowersForAuthenticatedUser.md b/docs/users/listFollowersForAuthenticatedUser.md index 9c3ddd5e8..2c8f4c6e0 100644 --- a/docs/users/listFollowersForAuthenticatedUser.md +++ b/docs/users/listFollowersForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-followers-of-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user). diff --git a/docs/users/listFollowersForUser.md b/docs/users/listFollowersForUser.md index bae2c478a..43eb28a4e 100644 --- a/docs/users/listFollowersForUser.md +++ b/docs/users/listFollowersForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-followers-of-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#list-followers-of-a-user). diff --git a/docs/users/listFollowingForUser.md b/docs/users/listFollowingForUser.md index a93b5ade5..a4a7bb2d7 100644 --- a/docs/users/listFollowingForUser.md +++ b/docs/users/listFollowingForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-the-people-a-user-follows). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#list-the-people-a-user-follows). diff --git a/docs/users/listGpgKeysForAuthenticated.md b/docs/users/listGpgKeysForAuthenticated.md index 4dd477325..e3132b8dd 100644 --- a/docs/users/listGpgKeysForAuthenticated.md +++ b/docs/users/listGpgKeysForAuthenticated.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user). diff --git a/docs/users/listGpgKeysForAuthenticatedUser.md b/docs/users/listGpgKeysForAuthenticatedUser.md index 6df89f258..f12eba644 100644 --- a/docs/users/listGpgKeysForAuthenticatedUser.md +++ b/docs/users/listGpgKeysForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user). diff --git a/docs/users/listGpgKeysForUser.md b/docs/users/listGpgKeysForUser.md index be199478b..2cc8c56b6 100644 --- a/docs/users/listGpgKeysForUser.md +++ b/docs/users/listGpgKeysForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-gpg-keys-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user). diff --git a/docs/users/listPublicEmailsForAuthenticated.md b/docs/users/listPublicEmailsForAuthenticated.md index 52f8ad537..fdcdd2a95 100644 --- a/docs/users/listPublicEmailsForAuthenticated.md +++ b/docs/users/listPublicEmailsForAuthenticated.md @@ -10,7 +10,7 @@ type: API method **Deprecated:** This method has been renamed to users.listPublicEmailsForAuthenticatedUser -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. +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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. ```js octokit.rest.users.listPublicEmailsForAuthenticated(); @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user). diff --git a/docs/users/listPublicEmailsForAuthenticatedUser.md b/docs/users/listPublicEmailsForAuthenticatedUser.md index a234c1caf..d259d9069 100644 --- a/docs/users/listPublicEmailsForAuthenticatedUser.md +++ b/docs/users/listPublicEmailsForAuthenticatedUser.md @@ -8,7 +8,7 @@ type: API method # List public email addresses for the authenticated user -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. +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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. ```js octokit.rest.users.listPublicEmailsForAuthenticatedUser(); @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user). diff --git a/docs/users/listPublicKeysForUser.md b/docs/users/listPublicKeysForUser.md index f656579e3..3a5b57b91 100644 --- a/docs/users/listPublicKeysForUser.md +++ b/docs/users/listPublicKeysForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-keys-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#list-public-keys-for-a-user). diff --git a/docs/users/listPublicSshKeysForAuthenticated.md b/docs/users/listPublicSshKeysForAuthenticated.md index e5c723260..404247ce6 100644 --- a/docs/users/listPublicSshKeysForAuthenticated.md +++ b/docs/users/listPublicSshKeysForAuthenticated.md @@ -40,4 +40,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user). diff --git a/docs/users/listPublicSshKeysForAuthenticatedUser.md b/docs/users/listPublicSshKeysForAuthenticatedUser.md index 54ddf04a7..09eb93a3b 100644 --- a/docs/users/listPublicSshKeysForAuthenticatedUser.md +++ b/docs/users/listPublicSshKeysForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user). diff --git a/docs/users/listSshSigningKeysForAuthenticatedUser.md b/docs/users/listSshSigningKeysForAuthenticatedUser.md index 971583082..407f0e3b0 100644 --- a/docs/users/listSshSigningKeysForAuthenticatedUser.md +++ b/docs/users/listSshSigningKeysForAuthenticatedUser.md @@ -38,4 +38,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user). diff --git a/docs/users/listSshSigningKeysForUser.md b/docs/users/listSshSigningKeysForUser.md index 92945f8b4..56eefb9ad 100644 --- a/docs/users/listSshSigningKeysForUser.md +++ b/docs/users/listSshSigningKeysForUser.md @@ -45,4 +45,4 @@ Page number of the results to fetch. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user). diff --git a/docs/users/setPrimaryEmailVisibilityForAuthenticated.md b/docs/users/setPrimaryEmailVisibilityForAuthenticated.md index 3c8a4907d..d11623c71 100644 --- a/docs/users/setPrimaryEmailVisibilityForAuthenticated.md +++ b/docs/users/setPrimaryEmailVisibilityForAuthenticated.md @@ -37,4 +37,4 @@ Denotes whether an email is publicly visible. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user). diff --git a/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md b/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md index d18d894e3..1c500fb66 100644 --- a/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md +++ b/docs/users/setPrimaryEmailVisibilityForAuthenticatedUser.md @@ -35,4 +35,4 @@ Denotes whether an email is publicly visible. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user). diff --git a/docs/users/unblock.md b/docs/users/unblock.md index b05ba0445..98790ce5a 100644 --- a/docs/users/unblock.md +++ b/docs/users/unblock.md @@ -8,6 +8,8 @@ type: API method # Unblock a user +Unblocks the given user and returns a 204. + ```js octokit.rest.users.unblock({ username, @@ -33,4 +35,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#unblock-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/blocking#unblock-a-user). diff --git a/docs/users/unfollow.md b/docs/users/unfollow.md index 45a7fae47..4bc467a66 100644 --- a/docs/users/unfollow.md +++ b/docs/users/unfollow.md @@ -35,4 +35,4 @@ The handle for the GitHub user account. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#unfollow-a-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/followers#unfollow-a-user). diff --git a/docs/users/updateAuthenticated.md b/docs/users/updateAuthenticated.md index 3a0a15ddb..13122c216 100644 --- a/docs/users/updateAuthenticated.md +++ b/docs/users/updateAuthenticated.md @@ -68,4 +68,4 @@ The new short biography of the user. -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users/#update-the-authenticated-user). +See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/users/users#update-the-authenticated-user). diff --git a/package-lock.json b/package-lock.json index 1c86497f1..43dd709c8 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^11.0.0" + "@octokit/types": "^12.0.0" }, "devDependencies": { "@gimenete/type-writer": "^0.1.5", @@ -1454,6 +1454,21 @@ "node": ">= 18" } }, + "node_modules/@octokit/core/node_modules/@octokit/openapi-types": { + "version": "18.1.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.1.1.tgz", + "integrity": "sha512-VRaeH8nCDtF5aXWnjPuEMIYf1itK/s3JYyJcWFJT8X9pSNnBtriDf7wlEWsGuhPLl4QIH4xM8fqTXDwJ3Mu6sw==", + "dev": true + }, + "node_modules/@octokit/core/node_modules/@octokit/types": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-11.1.0.tgz", + "integrity": "sha512-Fz0+7GyLm/bHt8fwEqgvRBWwIV1S6wRRyq+V6exRKLVWaKGsuy6H9QFYeBVDV7rK6fO3XwHgQOPxv+cLj2zpXQ==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^18.0.0" + } + }, "node_modules/@octokit/endpoint": { "version": "9.0.0", "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-9.0.0.tgz", @@ -1468,6 +1483,21 @@ "node": ">= 18" } }, + "node_modules/@octokit/endpoint/node_modules/@octokit/openapi-types": { + "version": "18.1.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.1.1.tgz", + "integrity": "sha512-VRaeH8nCDtF5aXWnjPuEMIYf1itK/s3JYyJcWFJT8X9pSNnBtriDf7wlEWsGuhPLl4QIH4xM8fqTXDwJ3Mu6sw==", + "dev": true + }, + "node_modules/@octokit/endpoint/node_modules/@octokit/types": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-11.1.0.tgz", + "integrity": "sha512-Fz0+7GyLm/bHt8fwEqgvRBWwIV1S6wRRyq+V6exRKLVWaKGsuy6H9QFYeBVDV7rK6fO3XwHgQOPxv+cLj2zpXQ==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^18.0.0" + } + }, "node_modules/@octokit/graphql": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-7.0.1.tgz", @@ -1482,10 +1512,25 @@ "node": ">= 18" } }, + "node_modules/@octokit/graphql/node_modules/@octokit/openapi-types": { + "version": "18.1.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.1.1.tgz", + "integrity": "sha512-VRaeH8nCDtF5aXWnjPuEMIYf1itK/s3JYyJcWFJT8X9pSNnBtriDf7wlEWsGuhPLl4QIH4xM8fqTXDwJ3Mu6sw==", + "dev": true + }, + "node_modules/@octokit/graphql/node_modules/@octokit/types": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-11.1.0.tgz", + "integrity": "sha512-Fz0+7GyLm/bHt8fwEqgvRBWwIV1S6wRRyq+V6exRKLVWaKGsuy6H9QFYeBVDV7rK6fO3XwHgQOPxv+cLj2zpXQ==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^18.0.0" + } + }, "node_modules/@octokit/openapi-types": { - "version": "18.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.0.0.tgz", - "integrity": "sha512-V8GImKs3TeQRxRtXFpG2wl19V7444NIOTDF24AWuIbmNaNYOQMWRbjcGDXV5B+0n887fgDcuMNOmlul+k+oJtw==" + "version": "19.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.0.0.tgz", + "integrity": "sha512-PclQ6JGMTE9iUStpzMkwLCISFn/wDeRjkZFIKALpvJQNBGwDoYYi2fFvuHwssoQ1rXI5mfh6jgTgWuddeUzfWw==" }, "node_modules/@octokit/request": { "version": "8.0.4", @@ -1517,19 +1562,49 @@ "node": ">= 18" } }, - "node_modules/@octokit/tsconfig": { - "version": "2.0.0", + "node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": { + "version": "18.1.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.1.1.tgz", + "integrity": "sha512-VRaeH8nCDtF5aXWnjPuEMIYf1itK/s3JYyJcWFJT8X9pSNnBtriDf7wlEWsGuhPLl4QIH4xM8fqTXDwJ3Mu6sw==", + "dev": true + }, + "node_modules/@octokit/request-error/node_modules/@octokit/types": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-11.1.0.tgz", + "integrity": "sha512-Fz0+7GyLm/bHt8fwEqgvRBWwIV1S6wRRyq+V6exRKLVWaKGsuy6H9QFYeBVDV7rK6fO3XwHgQOPxv+cLj2zpXQ==", "dev": true, - "license": "MIT" + "dependencies": { + "@octokit/openapi-types": "^18.0.0" + } }, - "node_modules/@octokit/types": { + "node_modules/@octokit/request/node_modules/@octokit/openapi-types": { + "version": "18.1.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-18.1.1.tgz", + "integrity": "sha512-VRaeH8nCDtF5aXWnjPuEMIYf1itK/s3JYyJcWFJT8X9pSNnBtriDf7wlEWsGuhPLl4QIH4xM8fqTXDwJ3Mu6sw==", + "dev": true + }, + "node_modules/@octokit/request/node_modules/@octokit/types": { "version": "11.1.0", "resolved": "https://registry.npmjs.org/@octokit/types/-/types-11.1.0.tgz", "integrity": "sha512-Fz0+7GyLm/bHt8fwEqgvRBWwIV1S6wRRyq+V6exRKLVWaKGsuy6H9QFYeBVDV7rK6fO3XwHgQOPxv+cLj2zpXQ==", + "dev": true, "dependencies": { "@octokit/openapi-types": "^18.0.0" } }, + "node_modules/@octokit/tsconfig": { + "version": "2.0.0", + "dev": true, + "license": "MIT" + }, + "node_modules/@octokit/types": { + "version": "12.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.0.0.tgz", + "integrity": "sha512-EzD434aHTFifGudYAygnFlS1Tl6KhbTynEWELQXIbTY8Msvb5nEqTZIm7sbPEt4mQYLZwu3zPKVdeIrw0g7ovg==", + "dependencies": { + "@octokit/openapi-types": "^19.0.0" + } + }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", "dev": true, diff --git a/package.json b/package.json index df2c2fb10..4756fe19a 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^11.0.0" + "@octokit/types": "^12.0.0" }, "devDependencies": { "@gimenete/type-writer": "^0.1.5", diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 44d4b5b19..078989dd2 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -8,8 +8,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add custom labels to a 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#add-custom-labels-to-a-self-hosted-runner-for-an-organization", + "description": "Add custom labels to a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -81,8 +81,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -167,8 +167,8 @@ "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", + "description": "Adds a repository to an organization secret when the `visibility` for\nrepository access is set to `selected`. The visibility is set when you [Create or\nupdate an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -235,7 +235,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", + "description": "Adds a repository to an organization variable that is available to selected repositories.\nOrganization variables that are available to selected repositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable", "previews": [], "headers": [], @@ -290,67 +290,6 @@ ], "renamed": null }, - { - "name": "Add a repository to a required workflow", - "scope": "actions", - "id": "addSelectedRepoToRequiredWorkflow", - "method": "PUT", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#add-a-repository-to-selected-repositories-list-for-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Success", "examples": null }, - { "code": 404, "description": "Resource Not Found", "examples": null }, - { "code": 422, "description": "Validation Error", "examples": null } - ], - "renamed": null - }, { "name": "Approve a workflow run for a fork pull request", "scope": "actions", @@ -361,7 +300,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request", "previews": [], "headers": [], "parameters": [ @@ -425,8 +364,8 @@ "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", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -489,7 +428,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-environment-variable", "previews": [], "headers": [], @@ -565,8 +504,8 @@ "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 [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n**Example encrypting a secret using Python**\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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", + "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). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret", "previews": [], "headers": [], "parameters": [ @@ -611,7 +550,7 @@ }, { "name": "encrypted_value", - "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.", + "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/actions/secrets#get-an-environment-public-key) endpoint.", "in": "BODY", "type": "string", "required": true, @@ -766,8 +705,8 @@ "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 [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n**Example encrypting a secret using Python**\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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", + "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). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -812,7 +751,7 @@ }, { "name": "encrypted_value", - "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 a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.", + "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 a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -860,7 +799,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", + "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-organization-variable", "previews": [], "headers": [], @@ -949,8 +888,8 @@ "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", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org --token TOKEN\n```", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -990,8 +929,8 @@ "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", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -1044,8 +983,8 @@ "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", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from 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/actions/self-hosted-runners#create-a-remove-token-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -1085,8 +1024,8 @@ "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", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -1139,7 +1078,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#create-a-repository-variable", "previews": [], "headers": [], @@ -1206,104 +1145,6 @@ ], "renamed": null }, - { - "name": "Create a required workflow", - "scope": "actions", - "id": "createRequiredWorkflow", - "method": "POST", - "url": "/orgs/{org}/actions/required_workflows", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Create a required workflow in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_file_path", - "description": "Path of the workflow file to be configured as a required workflow.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The ID of the repository that contains the workflow file.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scope", - "description": "Enable the required workflow for all repositories or selected repositories in the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["selected", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, { "name": "Create a workflow dispatch event", "scope": "actions", @@ -1314,7 +1155,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event", "previews": [], "headers": [], "parameters": [ @@ -1547,7 +1388,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/artifacts#delete-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -1603,8 +1444,8 @@ "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", + "description": "Deletes a secret in an environment using the secret name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-an-environment-secret", "previews": [], "headers": [], "parameters": [ @@ -1662,7 +1503,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable", "previews": [], "headers": [], @@ -1719,8 +1560,8 @@ "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", + "description": "Deletes a secret in an organization using the secret name.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -1763,7 +1604,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", + "description": "Deletes an organization variable using the variable name.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable", "previews": [], "headers": [], @@ -1807,8 +1648,8 @@ "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", + "description": "Deletes a secret in a repository using the secret name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#delete-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -1864,7 +1705,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable", "previews": [], "headers": [], @@ -1912,50 +1753,6 @@ "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, - { - "name": "Delete a required workflow", - "scope": "actions", - "id": "deleteRequiredWorkflow", - "method": "DELETE", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Deletes a required workflow configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, { "name": "Delete a self-hosted runner from an organization", "scope": "actions", @@ -1965,8 +1762,8 @@ "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", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization", "previews": [], "headers": [], "parameters": [ @@ -2009,8 +1806,8 @@ "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", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository", "previews": [], "headers": [], "parameters": [ @@ -2067,7 +1864,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -2124,7 +1921,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs", "previews": [], "headers": [], "parameters": [ @@ -2185,7 +1982,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], "headers": [], "parameters": [ @@ -2229,7 +2026,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflows#disable-a-workflow", "previews": [], "headers": [], "parameters": [ @@ -2285,8 +2082,8 @@ "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", + "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`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/artifacts#download-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -2359,7 +2156,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -2416,7 +2213,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. 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-workflow-run-attempt-logs", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs", "previews": [], "headers": [], "parameters": [ @@ -2486,7 +2283,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs", "previews": [], "headers": [], "parameters": [ @@ -2543,7 +2340,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization", "previews": [], "headers": [], "parameters": [ @@ -2587,7 +2384,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflows#enable-a-workflow", "previews": [], "headers": [], "parameters": [ @@ -2643,7 +2440,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization", "previews": [], "headers": [], @@ -2742,7 +2539,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository", "previews": [], "headers": [], @@ -2987,7 +2784,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\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-github-actions-cache-usage-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -3041,7 +2838,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists repositories and their GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -3108,7 +2905,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -3149,7 +2946,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the selected actions and reusable workflows 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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -3190,7 +2987,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the settings for selected actions and reusable workflows 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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -3244,7 +3041,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/artifacts#get-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -3310,8 +3107,8 @@ "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", + "description": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-public-key", "previews": [], "headers": [], "parameters": [ @@ -3364,8 +3161,8 @@ "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", + "description": "Gets a single environment secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-environment-secret", "previews": [], "headers": [], "parameters": [ @@ -3431,7 +3228,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-environment-variable", "previews": [], "headers": [], @@ -3499,7 +3296,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-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-default-workflow-permissions", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -3540,7 +3337,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -3594,7 +3391,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows 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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -3635,7 +3432,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in 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#get-github-actions-permissions-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -3689,7 +3486,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -3755,8 +3552,8 @@ "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", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-organization-public-key", "previews": [], "headers": [], "parameters": [ @@ -3796,8 +3593,8 @@ "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", + "description": "Gets a single organization secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -3850,7 +3647,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.", + "description": "Gets a specific variable in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-organization-variable", "previews": [], "headers": [], @@ -3905,7 +3702,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -3972,7 +3769,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in 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#get-github-actions-permissions-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -4033,8 +3830,8 @@ "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", + "description": "Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.\n\nAnyone with read access to the repository can use this endpoint.\nIf the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-a-repository-public-key", "previews": [], "headers": [], "parameters": [ @@ -4079,22 +3876,22 @@ "renamed": null }, { - "name": "Get a required workflow entity for a repository", + "name": "Get a repository secret", "scope": "actions", - "id": "getRepoRequiredWorkflow", + "id": "getRepoSecret", "method": "GET", - "url": "/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}", + "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific required workflow present 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. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-repository-required-workflow", + "description": "Gets a single repository secret without revealing its encrypted value.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4119,10 +3916,10 @@ "deprecated": null }, { - "name": "required_workflow_id_for_repo", - "description": "The ID of the required workflow that has run at least once in a repository.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -4138,31 +3935,97 @@ "description": "Response", "examples": [ { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"RequiredCI\",\"path\":\".github/workflows/required_ci.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg\",\"source_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octo-org/Hello-World\",\"owner\":{\"login\":\"octo-org\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octo-org_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octo-org/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octo-org/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octo-org/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octo-org/Hello-World/hooks\"}}" + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" } ] + } + ], + "renamed": null + }, + { + "name": "Get a repository variable", + "scope": "actions", + "id": "getRepoVariable", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/variables/{name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#get-a-repository-variable", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the variable.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2022-01-10T14:59:22Z\"}" + } + ] + } ], "renamed": null }, { - "name": "Get required workflow usage", + "name": "Get the review history for a workflow run", "scope": "actions", - "id": "getRepoRequiredWorkflowUsage", + "id": "getReviewsForRun", "method": "GET", - "url": "/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets the number of billable minutes used by a specific required workflow during the current billing cycle.\n\nBillable minutes only apply to required workflows running 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://docs.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-repository-required-workflow-usage", + "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/actions/workflow-runs#get-the-review-history-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4187,8 +4050,8 @@ "deprecated": null }, { - "name": "required_workflow_id_for_repo", - "description": "The ID of the required workflow that has run at least once in a repository.", + "name": "run_id", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -4206,44 +4069,30 @@ "description": "Response", "examples": [ { - "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}" + "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"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}}]" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "Get a repository secret", + "name": "Get a self-hosted runner for an organization", "scope": "actions", - "id": "getRepoSecret", + "id": "getSelfHostedRunnerForOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "url": "/orgs/{org}/actions/runners/{runner_id}", "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", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4255,10 +4104,10 @@ "deprecated": null }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -4274,7 +4123,7 @@ "description": "Response", "examples": [ { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] } @@ -4282,16 +4131,16 @@ "renamed": null }, { - "name": "Get a repository variable", + "name": "Get a self-hosted runner for a repository", "scope": "actions", - "id": "getRepoVariable", + "id": "getSelfHostedRunnerForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/variables/{name}", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#get-a-repository-variable", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -4322,62 +4171,8 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the variable.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2022-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a required workflow", - "scope": "actions", - "id": "getRequiredWorkflow", - "method": "GET", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Get a required workflow configured in an organization.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -4395,7 +4190,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}" + "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" } ] } @@ -4403,16 +4198,16 @@ "renamed": null }, { - "name": "Get the review history for a workflow run", + "name": "Get a workflow", "scope": "actions", - "id": "getReviewsForRun", + "id": "getWorkflow", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "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", + "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/actions/workflows#get-a-workflow", "previews": [], "headers": [], "parameters": [ @@ -4443,10 +4238,10 @@ "deprecated": null }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", + "name": "workflow_id", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", "in": "PATH", - "type": "integer", + "type": null, "required": true, "enum": null, "allowNull": false, @@ -4462,7 +4257,7 @@ "description": "Response", "examples": [ { - "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"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}}]" + "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" } ] } @@ -4470,22 +4265,22 @@ "renamed": null }, { - "name": "Get a self-hosted runner for an organization", + "name": "Get the level of access for workflows outside of the repository", "scope": "actions", - "id": "getSelfHostedRunnerForOrg", + "id": "getWorkflowAccessToRepository", "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}", + "url": "/repos/{owner}/{repo}/actions/permissions/access", "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", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -4497,10 +4292,10 @@ "deprecated": null }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -4514,26 +4309,22 @@ { "code": 200, "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] + "examples": [{ "data": "{\"access_level\":\"organization\"}" }] } ], "renamed": null }, { - "name": "Get a self-hosted runner for a repository", + "name": "Get a workflow run", "scope": "actions", - "id": "getSelfHostedRunnerForRepo", + "id": "getWorkflowRun", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "url": "/repos/{owner}/{repo}/actions/runs/{run_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", + "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/actions/workflow-runs#get-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -4564,8 +4355,8 @@ "deprecated": null }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", + "name": "run_id", + "description": "The unique identifier of the workflow run.", "in": "PATH", "type": "integer", "required": true, @@ -4575,6 +4366,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -4583,7 +4387,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" } ] } @@ -4591,16 +4395,16 @@ "renamed": null }, { - "name": "Get a workflow", + "name": "Get a workflow run attempt", "scope": "actions", - "id": "getWorkflow", + "id": "getWorkflowRunAttempt", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", "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", + "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt", "previews": [], "headers": [], "parameters": [ @@ -4631,10 +4435,10 @@ "deprecated": null }, { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "name": "run_id", + "description": "The unique identifier of the workflow run.", "in": "PATH", - "type": null, + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -4642,40 +4446,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the level of access for workflows outside of the repository", - "scope": "actions", - "id": "getWorkflowAccessToRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions/access", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "attempt_number", + "description": "The attempt number of the workflow run.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -4685,11 +4461,11 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, + "name": "exclude_pull_requests", + "description": "If `true` pull requests are omitted from the response (empty array).", + "in": "QUERY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -4702,22 +4478,26 @@ { "code": 200, "description": "Response", - "examples": [{ "data": "{\"access_level\":\"organization\"}" }] + "examples": [ + { + "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + } + ] } ], "renamed": null }, { - "name": "Get a workflow run", + "name": "Get workflow run usage", "scope": "actions", - "id": "getWorkflowRun", + "id": "getWorkflowRunUsage", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", "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", + "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://docs.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/actions/workflow-runs#get-workflow-run-usage", "previews": [], "headers": [], "parameters": [ @@ -4759,19 +4539,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -4780,7 +4547,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + "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}" } ] } @@ -4788,16 +4555,16 @@ "renamed": null }, { - "name": "Get a workflow run attempt", + "name": "Get workflow usage", "scope": "actions", - "id": "getWorkflowRunAttempt", + "id": "getWorkflowUsage", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt", + "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://docs.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/actions/workflows#get-workflow-usage", "previews": [], "headers": [], "parameters": [ @@ -4828,23 +4595,10 @@ "deprecated": null }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", + "name": "workflow_id", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", "in": "PATH", - "type": "integer", + "type": null, "required": true, "enum": null, "allowNull": false, @@ -4852,19 +4606,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -4873,7 +4614,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}" } ] } @@ -4881,16 +4622,16 @@ "renamed": null }, { - "name": "Get workflow run usage", + "name": "List artifacts for a repository", "scope": "actions", - "id": "getWorkflowRunUsage", + "id": "listArtifactsForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", + "url": "/repos/{owner}/{repo}/actions/artifacts", "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://docs.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", + "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/actions/artifacts#list-artifacts-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -4921,52 +4662,11 @@ "deprecated": null }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "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}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get workflow usage", - "scope": "actions", - "id": "getWorkflowUsage", - "method": "GET", - "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://docs.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": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -4975,11 +4675,11 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -4988,11 +4688,11 @@ "deprecated": null }, { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, + "name": "name", + "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5007,7 +4707,7 @@ "description": "Response", "examples": [ { - "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}" + "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}" } ] } @@ -5015,24 +4715,24 @@ "renamed": null }, { - "name": "List artifacts for a repository", + "name": "List environment secrets", "scope": "actions", - "id": "listArtifactsForRepo", + "id": "listEnvironmentSecrets", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts", + "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", "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", + "description": "Lists all secrets available in an environment without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-environment-secrets", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "repository_id", + "description": "The unique identifier of the repository.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -5042,8 +4742,8 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "environment_name", + "description": "The name of the environment.", "in": "PATH", "type": "string", "required": true, @@ -5079,19 +4779,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "name", - "description": "Filters artifacts by exact match on their name field.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -5100,7 +4787,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}" + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -5108,16 +4795,16 @@ "renamed": null }, { - "name": "List environment secrets", + "name": "List environment variables", "scope": "actions", - "id": "listEnvironmentSecrets", + "id": "listEnvironmentVariables", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", + "url": "/repositories/{repository_id}/environments/{environment_name}/variables", "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", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables", "previews": [], "headers": [], "parameters": [ @@ -5149,7 +4836,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 30).", "in": "QUERY", "type": "integer", "required": false, @@ -5180,7 +4867,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -5188,24 +4875,24 @@ "renamed": null }, { - "name": "List environment variables", + "name": "List jobs for a workflow run", "scope": "actions", - "id": "listEnvironmentVariables", + "id": "listJobsForWorkflowRun", "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/variables", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables", + "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/actions/workflow-jobs#list-jobs-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The unique identifier of the repository.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -5215,8 +4902,8 @@ "deprecated": null }, { - "name": "environment_name", - "description": "The name of the environment.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5227,9 +4914,35 @@ "alias": null, "deprecated": null }, + { + "name": "run_id", + "description": "The unique identifier of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["latest", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -5260,7 +4973,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" } ] } @@ -5268,16 +4981,16 @@ "renamed": null }, { - "name": "List jobs for a workflow run", + "name": "List jobs for a workflow run attempt", "scope": "actions", - "id": "listJobsForWorkflowRun", + "id": "listJobsForWorkflowRunAttempt", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/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", + "description": "Lists jobs for a specific workflow run attempt. 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/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt", "previews": [], "headers": [], "parameters": [ @@ -5321,12 +5034,12 @@ "deprecated": null }, { - "name": "filter", - "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], + "name": "attempt_number", + "description": "The attempt number of the workflow run.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -5369,21 +5082,77 @@ "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" } ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List labels for a self-hosted runner for an organization", + "scope": "actions", + "id": "listLabelsForSelfHostedRunnerForOrg", + "method": "GET", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], "renamed": null }, { - "name": "List jobs for a workflow run attempt", + "name": "List labels for a self-hosted runner for a repository", "scope": "actions", - "id": "listJobsForWorkflowRunAttempt", + "id": "listLabelsForSelfHostedRunnerForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists jobs for a specific workflow run attempt. 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-attempt", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -5414,8 +5183,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "The unique identifier of the workflow run.", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -5425,12 +5194,41 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List organization secrets", + "scope": "actions", + "id": "listOrgSecrets", + "method": "GET", + "url": "/orgs/{org}/actions/secrets", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all secrets available in an organization without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-organization-secrets", + "previews": [], + "headers": [], + "parameters": [ { - "name": "attempt_number", - "description": "The attempt number of the workflow run.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -5472,25 +5270,24 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}" + "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "List labels for a self-hosted runner for an organization", + "name": "List organization variables", "scope": "actions", - "id": "listLabelsForSelfHostedRunnerForOrg", + "id": "listOrgVariables", "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}/labels", + "url": "/orgs/{org}/actions/variables", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all labels for a 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#list-labels-for-a-self-hosted-runner-for-an-organization", + "description": "Lists all organization variables.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#list-organization-variables", "previews": [], "headers": [], "parameters": [ @@ -5508,11 +5305,24 @@ "deprecated": null }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 30).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5527,25 +5337,24 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + "data": "{\"total_count\":3,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"ACTIONS_RUNNER_DEBUG\",\"value\":true,\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"ADMIN_EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories\"}]}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "List labels for a self-hosted runner for a repository", + "name": "List repository organization secrets", "scope": "actions", - "id": "listLabelsForSelfHostedRunnerForRepo", + "id": "listRepoOrganizationSecrets", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels", + "url": "/repos/{owner}/{repo}/actions/organization-secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository", + "description": "Lists all organization secrets shared with a repository without revealing their encrypted\nvalues.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets", "previews": [], "headers": [], "parameters": [ @@ -5576,11 +5385,24 @@ "deprecated": null }, { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -5595,31 +5417,43 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "List organization secrets", + "name": "List repository organization variables", "scope": "actions", - "id": "listOrgSecrets", + "id": "listRepoOrganizationVariables", "method": "GET", - "url": "/orgs/{org}/actions/secrets", + "url": "/repos/{owner}/{repo}/actions/organization-variables", "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", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5632,7 +5466,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 30).", "in": "QUERY", "type": "integer", "required": false, @@ -5663,7 +5497,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" + "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -5671,22 +5505,35 @@ "renamed": null }, { - "name": "List organization variables", + "name": "List repository secrets", "scope": "actions", - "id": "listOrgVariables", + "id": "listRepoSecrets", "method": "GET", - "url": "/orgs/{org}/actions/variables", + "url": "/repos/{owner}/{repo}/actions/secrets", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#list-organization-variables", + "description": "Lists all secrets available in a repository without revealing their encrypted\nvalues.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `secrets` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-repository-secrets", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5699,7 +5546,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -5730,7 +5577,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"ACTIONS_RUNNER_DEBUG\",\"value\":true,\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"ADMIN_EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories\"}]}" + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -5738,16 +5585,16 @@ "renamed": null }, { - "name": "List repository organization secrets", + "name": "List repository variables", "scope": "actions", - "id": "listRepoOrganizationSecrets", + "id": "listRepoVariables", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/organization-secrets", + "url": "/repos/{owner}/{repo}/actions/variables", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organization secrets shared with 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/actions/secrets#list-repository-organization-secrets", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-variables", "previews": [], "headers": [], "parameters": [ @@ -5779,7 +5626,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The number of results per page (max 30).", "in": "QUERY", "type": "integer", "required": false, @@ -5810,7 +5657,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" } ] } @@ -5818,16 +5665,16 @@ "renamed": null }, { - "name": "List repository organization variables", + "name": "List repository workflows", "scope": "actions", - "id": "listRepoOrganizationVariables", + "id": "listRepoWorkflows", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/organization-variables", + "url": "/repos/{owner}/{repo}/actions/workflows", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-organization-variables", + "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/actions/workflows#list-repository-workflows", "previews": [], "headers": [], "parameters": [ @@ -5859,7 +5706,7 @@ }, { "name": "per_page", - "description": "The number of results per page (max 30).", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -5890,7 +5737,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" } ] } @@ -5898,16 +5745,16 @@ "renamed": null }, { - "name": "List repository required workflows", + "name": "List runner applications for an organization", "scope": "actions", - "id": "listRepoRequiredWorkflows", + "id": "listRunnerApplicationsForOrg", "method": "GET", - "url": "/repos/{org}/{repo}/actions/required_workflows", + "url": "/orgs/{org}/actions/runners/downloads", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists the required 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. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-required-workflows", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -5923,10 +5770,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List runner applications for a repository", + "scope": "actions", + "id": "listRunnerApplicationsForRepo", + "method": "GET", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -5938,24 +5813,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -5970,31 +5832,30 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"required_workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"RequiredCI\",\"path\":\".github/workflows/required_ci.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg\",\"source_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octo-org/Hello-World\",\"owner\":{\"login\":\"octo-org\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octo-org_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octo-org/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octo-org/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octo-org/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octo-org/Hello-World/hooks\"}}]}" + "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "List repository secrets", + "name": "List selected repositories for an organization secret", "scope": "actions", - "id": "listRepoSecrets", + "id": "listSelectedReposForOrgSecret", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", + "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", "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", + "description": "Lists all repositories that have been selected when the `visibility`\nfor repository access to a secret is set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6006,8 +5867,8 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -6019,8 +5880,8 @@ "deprecated": null }, { - "name": "per_page", - "description": "The number of results per page (max 100).", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", "type": "integer", "required": false, @@ -6032,8 +5893,8 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6051,7 +5912,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":1,\"repositories\":[{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" } ] } @@ -6059,22 +5920,22 @@ "renamed": null }, { - "name": "List repository variables", + "name": "List selected repositories for an organization variable", "scope": "actions", - "id": "listRepoVariables", + "id": "listSelectedReposForOrgVariable", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/variables", + "url": "/orgs/{org}/actions/variables/{name}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-variables", + "description": "Lists all repositories that can access an organization variable\nthat is available to selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6086,8 +5947,8 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "name", + "description": "The name of the variable.", "in": "PATH", "type": "string", "required": true, @@ -6099,8 +5960,8 @@ "deprecated": null }, { - "name": "per_page", - "description": "The number of results per page (max 30).", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", "type": "integer", "required": false, @@ -6112,8 +5973,8 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "per_page", + "description": "The number of results per page (max 100).", "in": "QUERY", "type": "integer", "required": false, @@ -6131,43 +5992,35 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"total_count\":1,\"repositories\":[{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" } ] + }, + { + "code": 409, + "description": "Response when the visibility of the variable is not set to `selected`", + "examples": null } ], "renamed": null }, { - "name": "List repository workflows", + "name": "List selected repositories enabled for GitHub Actions in an organization", "scope": "actions", - "id": "listRepoWorkflows", + "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", + "url": "/orgs/{org}/actions/permissions/repositories", "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", + "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/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -6211,461 +6064,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a required workflow", - "scope": "actions", - "id": "listRequiredWorkflowRuns", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "List all workflow runs for a required workflow. 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. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-required-workflow-runs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id_for_repo", - "description": "The ID of the required workflow that has run at least once in a repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting", - "pending" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "Returns workflow runs with the `check_suite_id` that you specify.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head_sha", - "description": "Only returns workflow runs that are associated with the specified `head_sha`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List required workflows", - "scope": "actions", - "id": "listRequiredWorkflows", - "method": "GET", - "url": "/orgs/{org}/actions/required_workflows", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "List all required workflows in an organization.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-required-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"required_workflows\":[{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/organizations/org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}},{\"id\":30433643,\"name\":\"Required Linter\",\"path\":\".github/workflows/lint.yml\",\"scope\":\"all\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for an organization", - "scope": "actions", - "id": "listRunnerApplicationsForOrg", - "method": "GET", - "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": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for a repository", - "scope": "actions", - "id": "listRunnerApplicationsForRepo", - "method": "GET", - "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": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories for an organization secret", - "scope": "actions", - "id": "listSelectedReposForOrgSecret", - "method": "GET", - "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": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" + "data": "{\"total_count\":1,\"repositories\":[{\"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,\"template_repository\":null,\"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://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" } ] } @@ -6673,63 +6072,24 @@ "renamed": null }, { - "name": "List selected repositories for an organization variable", + "name": "List self-hosted runners for an organization", "scope": "actions", - "id": "listSelectedReposForOrgVariable", + "id": "listSelfHostedRunnersForOrg", "method": "GET", - "url": "/orgs/{org}/actions/variables/{name}/repositories", + "url": "/orgs/{org}/actions/runners", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable", + "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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization", "previews": [], "headers": [], "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "name", - "description": "The name of the variable.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "The name of a self-hosted runner.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -6737,40 +6097,7 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" - } - ] }, - { - "code": 409, - "description": "Response when the visibility of the variable is not set to `selected`", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "GET", - "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": [], - "headers": [], - "parameters": [ { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -6817,7 +6144,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"repositories\":[{\"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,\"template_repository\":null,\"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://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" + "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" } ] } @@ -6825,92 +6152,24 @@ "renamed": null }, { - "name": "List selected repositories for a required workflow", - "scope": "actions", - "id": "listSelectedRepositoriesRequiredWorkflow", - "method": "GET", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-required-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Success", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"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,\"template_repository\":null,\"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://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 404, "description": "Resource Not Found", "examples": null } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for an organization", + "name": "List self-hosted runners for a repository", "scope": "actions", - "id": "listSelfHostedRunnersForOrg", + "id": "listSelfHostedRunnersForRepo", "method": "GET", - "url": "/orgs/{org}/actions/runners", + "url": "/repos/{owner}/{repo}/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", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", + "name": "name", + "description": "The name of a self-hosted runner.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -6919,47 +6178,6 @@ "alias": null, "deprecated": null }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for a repository", - "scope": "actions", - "id": "listSelfHostedRunnersForRepo", - "method": "GET", - "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": [], - "headers": [], - "parameters": [ { "name": "owner", "description": "The account owner of the repository. The name is not case sensitive.", @@ -7036,7 +6254,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts", "previews": [], "headers": [], "parameters": [ @@ -7104,6 +6322,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -7129,7 +6360,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow", "previews": [], "headers": [], "parameters": [ @@ -7324,7 +6555,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" } ] } @@ -7341,7 +6572,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -7523,7 +6754,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"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},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"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},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"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},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" } ] } @@ -7539,8 +6770,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Re-run a job and its dependent jobs in 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#re-run-job-for-workflow-run", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -7617,7 +6848,7 @@ "deprecationDate": null, "removalDate": null, "description": "Re-runs 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#re-run-a-workflow", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow", "previews": [], "headers": [], "parameters": [ @@ -7693,7 +6924,7 @@ "deprecationDate": null, "removalDate": null, "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -7768,8 +6999,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\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#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", + "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -7823,149 +7054,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove a custom label from a self-hosted runner for an organization", - "scope": "actions", - "id": "removeCustomLabelFromSelfHostedRunnerForOrg", - "method": "DELETE", - "url": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of a self-hosted runner's custom label.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a custom label from a self-hosted runner for a repository", - "scope": "actions", - "id": "removeCustomLabelFromSelfHostedRunnerForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -7995,6 +7085,61 @@ "alias": null, "deprecated": null }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Remove a custom label from a self-hosted runner for an organization", + "scope": "actions", + "id": "removeCustomLabelFromSelfHostedRunnerForOrg", + "method": "DELETE", + "url": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "runner_id", "description": "Unique identifier of the self-hosted runner.", @@ -8042,22 +7187,22 @@ "renamed": null }, { - "name": "Remove selected repository from an organization secret", + "name": "Remove a custom label from a self-hosted runner for a repository", "scope": "actions", - "id": "removeSelectedRepoFromOrgSecret", + "id": "removeCustomLabelFromSelfHostedRunnerForRepo", "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}", "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", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "The organization name. The name is not case sensitive.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -8069,8 +7214,8 @@ "deprecated": null }, { - "name": "secret_name", - "description": "The name of the secret.", + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -8082,8 +7227,8 @@ "deprecated": null }, { - "name": "repository_id", - "description": "", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "PATH", "type": "integer", "required": true, @@ -8093,33 +7238,51 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "The name of a self-hosted runner's custom label.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 204, - "description": "Response when repository was removed from the selected list", - "examples": null + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" + } + ] }, + { "code": 404, "description": "Resource not found", "examples": null }, { - "code": 409, - "description": "Conflict when visibility type not set to selected", + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", "examples": null } ], "renamed": null }, { - "name": "Remove selected repository from an organization variable", + "name": "Remove selected repository from an organization secret", "scope": "actions", - "id": "removeSelectedRepoFromOrgVariable", + "id": "removeSelectedRepoFromOrgSecret", "method": "DELETE", - "url": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", + "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable", + "description": "Removes a repository from an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -8137,8 +7300,8 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the variable.", + "name": "secret_name", + "description": "The name of the secret.", "in": "PATH", "type": "string", "required": true, @@ -8164,26 +7327,30 @@ } ], "responses": [ - { "code": 204, "description": "Response", "examples": null }, + { + "code": 204, + "description": "Response when repository was removed from the selected list", + "examples": null + }, { "code": 409, - "description": "Response when the visibility of the variable is not set to `selected`", + "description": "Conflict when visibility type not set to selected", "examples": null } ], "renamed": null }, { - "name": "Remove a selected repository from required workflow", + "name": "Remove selected repository from an organization variable", "scope": "actions", - "id": "removeSelectedRepoFromRequiredWorkflow", + "id": "removeSelectedRepoFromOrgVariable", "method": "DELETE", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}", + "url": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-repository-from-selected-repositories-list-for-a-required-workflow", + "description": "Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "documentationUrl": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable", "previews": [], "headers": [], "parameters": [ @@ -8201,10 +7368,10 @@ "deprecated": null }, { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", + "name": "name", + "description": "The name of the variable.", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -8215,7 +7382,7 @@ }, { "name": "repository_id", - "description": "The unique identifier of the repository.", + "description": "", "in": "PATH", "type": "integer", "required": true, @@ -8228,9 +7395,12 @@ } ], "responses": [ - { "code": 204, "description": "Success", "examples": null }, - { "code": 404, "description": "Resource Not Found", "examples": null }, - { "code": 422, "description": "Validation Error", "examples": null } + { "code": 204, "description": "Response", "examples": null }, + { + "code": 409, + "description": "Response when the visibility of the variable is not set to `selected`", + "examples": null + } ], "renamed": null }, @@ -8243,7 +7413,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nGitHub Apps must have read and write permission for **Deployments** to use this endpoint.", + "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have read and write permission for **Deployments** to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run", "previews": [], "headers": [], @@ -8301,7 +7471,7 @@ "deprecationDate": null, "removalDate": null, "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run", + "documentationUrl": "https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run", "previews": [], "headers": [], "parameters": [ @@ -8407,7 +7577,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the actions and reusable workflows 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#set-allowed-actions-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8477,7 +7647,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the actions and reusable workflows 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\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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -8559,8 +7729,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-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#set-custom-labels-for-a-self-hosted-runner-for-an-organization", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8632,8 +7802,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "documentationUrl": "https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -8719,7 +7889,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-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-default-workflow-permissions", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8778,7 +7948,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -8855,7 +8025,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows 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#set-github-actions-permissions-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8912,7 +8082,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in 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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -8981,8 +8151,8 @@ "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", + "description": "Replaces all repositories for an organization secret when the `visibility`\nfor repository access is set to `selected`. The visibility is set when you [Create\nor update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret).\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `secrets` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.", + "documentationUrl": "https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -9014,7 +8184,7 @@ }, { "name": "selected_repository_ids", - "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 [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-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.", + "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 [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -9038,7 +8208,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", + "description": "Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their `visibility` field set to `selected`.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this\nendpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable", "previews": [], "headers": [], @@ -9093,63 +8263,6 @@ ], "renamed": null }, - { - "name": "Sets repositories for a required workflow", - "scope": "actions", - "id": "setSelectedReposToRequiredWorkflow", - "method": "PUT", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Sets the repositories for a required workflow that is required for selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "The IDs of the repositories for which the workflow should be required.", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, { "name": "Set selected repositories enabled for GitHub Actions in an organization", "scope": "actions", @@ -9160,7 +8273,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization", "previews": [], "headers": [], "parameters": [ @@ -9204,7 +8317,7 @@ "deprecationDate": null, "removalDate": null, "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository", + "documentationUrl": "https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository", "previews": [], "headers": [], "parameters": [ @@ -9260,7 +8373,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-environment-variable", "previews": [], "headers": [], @@ -9330,7 +8443,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.", + "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-organization-variable", "previews": [], "headers": [], @@ -9413,7 +8526,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "documentationUrl": "https://docs.github.com/rest/actions/variables#update-a-repository-variable", "previews": [], "headers": [], @@ -9474,117 +8587,6 @@ "responses": [{ "code": 204, "description": "Response", "examples": null }], "renamed": null }, - { - "name": "Update a required workflow", - "scope": "actions", - "id": "updateRequiredWorkflow", - "method": "PATCH", - "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Update a required workflow in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"", - "documentationUrl": "https://docs.github.com/rest/reference/actions#update-a-required-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_workflow_id", - "description": "The unique identifier of the required workflow.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_file_path", - "description": "Path of the workflow file to be configured as a required workflow.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The ID of the repository that contains the workflow file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scope", - "description": "Enable the required workflow for all repositories or selected repositories in the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["selected", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "A list of repository IDs where you want to enable the required workflow. A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, { "name": "Check if a repository is starred by the authenticated user", "scope": "activity", @@ -9594,8 +8596,8 @@ "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", + "description": "Whether the authenticated user has starred the repository.", + "documentationUrl": "https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -9656,8 +8658,8 @@ "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", + "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/activity/watching#set-a-repository-subscription).", + "documentationUrl": "https://docs.github.com/rest/activity/watching#delete-a-repository-subscription", "previews": [], "headers": [], "parameters": [ @@ -9700,14 +8702,14 @@ "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", + "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/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -9741,7 +8743,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/feeds#get-feeds", "previews": [], "headers": [], "parameters": [], @@ -9767,8 +8769,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-repository-subscription", + "description": "Gets information about whether the authenticated user is subscribed to the repository.", + "documentationUrl": "https://docs.github.com/rest/activity/watching#get-a-repository-subscription", "previews": [], "headers": [], "parameters": [ @@ -9828,13 +8830,13 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a notification thread.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#get-a-thread", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -9875,14 +8877,14 @@ "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", + "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/activity/watching#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/activity/notifications#get-a-thread-subscription-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -9924,7 +8926,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -9991,7 +8993,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -10023,7 +9025,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -10109,7 +9111,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -10189,7 +9191,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-public-events", "previews": [], "headers": [], "parameters": [ @@ -10246,7 +9248,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-network-of-repositories", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories", "previews": [], "headers": [], "parameters": [ @@ -10330,7 +9332,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-for-a-user", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-public-events-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -10397,7 +9399,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-organization-events", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-public-organization-events", "previews": [], "headers": [], "parameters": [ @@ -10464,7 +9466,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -10531,7 +9533,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-public-events-received-by-a-user", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user", "previews": [], "headers": [], "parameters": [ @@ -10598,7 +9600,7 @@ "deprecationDate": null, "removalDate": null, "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-events", + "documentationUrl": "https://docs.github.com/rest/activity/events#list-repository-events", "previews": [], "headers": [], "parameters": [ @@ -10678,7 +9680,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all notifications for the current user in the specified repository.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -10736,7 +9738,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -10810,7 +9812,7 @@ "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: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -10906,7 +9908,7 @@ "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: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-repositories-starred-by-a-user", + "documentationUrl": "https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user", "previews": [], "headers": [], "parameters": [ @@ -10999,7 +10001,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user", "previews": [], "headers": [], "parameters": [ @@ -11066,7 +10068,7 @@ "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: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-stargazers", + "documentationUrl": "https://docs.github.com/rest/activity/starring#list-stargazers", "previews": [], "headers": [], "parameters": [ @@ -11154,7 +10156,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -11215,7 +10217,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the people watching the specified repository.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#list-watchers", + "documentationUrl": "https://docs.github.com/rest/activity/watching#list-watchers", "previews": [], "headers": [], "parameters": [ @@ -11294,8 +10296,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Marks all notifications as \"read\" for the current user. 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", + "description": "Marks all notifications as \"read\" for the current user. 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/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#mark-notifications-as-read", "previews": [], "headers": [], "parameters": [ @@ -11356,8 +10358,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Marks all notifications in a repository as \"read\" for the current user. 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", + "description": "Marks all notifications in a repository as \"read\" for the current user. 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/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read", "previews": [], "headers": [], "parameters": [ @@ -11425,13 +10427,13 @@ "deprecationDate": null, "removalDate": null, "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.", - "documentationUrl": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -11459,8 +10461,8 @@ "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", + "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/activity/watching#delete-a-repository-subscription) completely.", + "documentationUrl": "https://docs.github.com/rest/activity/watching#set-a-repository-subscription", "previews": [], "headers": [], "parameters": [ @@ -11539,14 +10541,14 @@ "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", + "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/activity/notifications#delete-a-thread-subscription) endpoint.", + "documentationUrl": "https://docs.github.com/rest/activity/notifications#set-a-thread-subscription", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).", + "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -11601,7 +10603,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -11654,8 +10656,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", + "description": "Unstar a repository that the authenticated user has previously starred.", + "documentationUrl": "https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -11709,7 +10711,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -11766,7 +10768,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -11815,7 +10817,7 @@ "deprecationDate": null, "removalDate": null, "description": "OAuth applications and GitHub applications with OAuth authorizations can use this 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 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", + "documentationUrl": "https://docs.github.com/rest/apps/oauth-applications#check-a-token", "previews": [], "headers": [], "parameters": [ @@ -11875,7 +10877,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#create-a-github-app-from-a-manifest", "previews": [], "headers": [], "parameters": [ @@ -11922,7 +10924,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app", "previews": [], "headers": [], "parameters": [ @@ -11967,7 +10969,7 @@ }, { "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "in": "BODY", "type": "object", "required": false, @@ -12456,7 +11458,7 @@ "deprecationDate": null, "removalDate": null, "description": "OAuth and GitHub application owners can revoke a grant for their 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 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", + "documentationUrl": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-authorization", "previews": [], "headers": [], "parameters": [ @@ -12506,8 +11508,8 @@ "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", + "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/apps/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/apps/apps#delete-an-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -12541,7 +11543,7 @@ "deprecationDate": null, "removalDate": null, "description": "OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#delete-an-app-token", + "documentationUrl": "https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token", "previews": [], "headers": [], "parameters": [ @@ -12591,8 +11593,8 @@ "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", + "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/apps/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/apps/apps#get-the-authenticated-app", "previews": [], "headers": [], "parameters": [], @@ -12602,7 +11604,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" + "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"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},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" } ] } @@ -12619,7 +11621,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#get-an-app", "previews": [], "headers": [], "parameters": [ @@ -12643,7 +11645,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" + "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"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},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" } ] }, @@ -12662,7 +11664,7 @@ "deprecationDate": null, "removalDate": null, "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#get-an-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -12686,7 +11688,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"account\":{\"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},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" + "data": "{\"id\":1,\"account\":{\"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},\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" } ] }, @@ -12704,7 +11706,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -12728,7 +11730,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" + "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" } ] } @@ -12745,7 +11747,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -12782,7 +11784,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" + "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" } ] }, @@ -12800,8 +11802,8 @@ "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", + "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/apps/marketplace#get-a-subscription-plan-for-an-account", "previews": [], "headers": [], "parameters": [ @@ -12851,8 +11853,8 @@ "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", + "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/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed", "previews": [], "headers": [], "parameters": [ @@ -12903,7 +11905,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -12927,7 +11929,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" + "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" } ] } @@ -12944,7 +11946,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/webhooks#get-a-webhook-configuration-for-an-app", "previews": [], "headers": [], "parameters": [], @@ -12971,7 +11973,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/webhooks#get-a-delivery-for-an-app-webhook", "previews": [], "headers": [], "parameters": [ @@ -13018,8 +12020,8 @@ "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", + "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/apps/marketplace#list-accounts-for-a-plan", "previews": [], "headers": [], "parameters": [ @@ -13122,8 +12124,8 @@ "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", + "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/apps/marketplace#list-accounts-for-a-plan-stubbed", "previews": [], "headers": [], "parameters": [ @@ -13220,8 +12222,8 @@ "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", + "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 access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/apps/installations#list-repositories-accessible-to-the-user-access-token", "previews": [], "headers": [], "parameters": [ @@ -13291,7 +12293,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all the pending installation requests for the authenticated GitHub App.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#list-installation-requests-for-the-authenticated-app", + "documentationUrl": "https://docs.github.com/rest/apps/apps#list-installation-requests-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -13350,8 +12352,8 @@ "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", + "description": "You must use a [JWT](https://docs.github.com/enterprise-server@3.9/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/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app", "previews": [], "headers": [], "parameters": [ @@ -13383,7 +12385,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -13430,8 +12432,8 @@ "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", + "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 access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/apps/installations#list-app-installations-accessible-to-the-user-access-token", "previews": [], "headers": [], "parameters": [ @@ -13468,7 +12470,7 @@ "description": "You can find the permissions for the installation under the `permissions` key.", "examples": [ { - "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"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},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"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},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" + "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"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},\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"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},\"access_tokens_url\":\"https://api.github.com/app/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" } ] }, @@ -13491,8 +12493,8 @@ "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", + "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/apps/marketplace#list-plans", "previews": [], "headers": [], "parameters": [ @@ -13551,8 +12553,8 @@ "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", + "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/apps/marketplace#list-plans-stubbed", "previews": [], "headers": [], "parameters": [ @@ -13611,7 +12613,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/installations#list-repositories-accessible-to-the-app-installation", "previews": [], "headers": [], "parameters": [ @@ -13671,8 +12673,8 @@ "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", + "description": "Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps).", + "documentationUrl": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -13732,8 +12734,8 @@ "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", + "description": "Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps).", + "documentationUrl": "https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed", "previews": [], "headers": [], "parameters": [ @@ -13793,7 +12795,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/webhooks#list-deliveries-for-an-app-webhook", "previews": [], "headers": [], "parameters": [ @@ -13867,7 +12869,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/webhooks#redeliver-a-delivery-for-an-app-webhook", "previews": [], "headers": [], "parameters": [ @@ -13911,7 +12913,7 @@ "deprecationDate": null, "removalDate": null, "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.\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", + "documentationUrl": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -13973,7 +12975,7 @@ "deprecationDate": null, "removalDate": null, "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`.\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", + "documentationUrl": "https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -14027,7 +13029,7 @@ "deprecationDate": null, "removalDate": null, "description": "OAuth applications and GitHub applications with OAuth authorizations 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 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", + "documentationUrl": "https://docs.github.com/rest/apps/oauth-applications#reset-a-token", "previews": [], "headers": [], "parameters": [ @@ -14085,8 +13087,8 @@ "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", + "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/apps/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/apps/installations#revoke-an-installation-access-token", "previews": [], "headers": [], "parameters": [], @@ -14102,7 +13104,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.", + "description": "Use a non-scoped user access token to create a repository scoped and/or permission scoped user 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`.", "documentationUrl": "https://docs.github.com/rest/apps/apps#create-a-scoped-access-token", "previews": [], "headers": [], @@ -14135,7 +13137,7 @@ }, { "name": "target", - "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", + "description": "The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.", "in": "BODY", "type": "string", "required": false, @@ -14148,7 +13150,7 @@ }, { "name": "target_id", - "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", + "description": "The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.", "in": "BODY", "type": "integer", "required": false, @@ -14161,7 +13163,7 @@ }, { "name": "repositories", - "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "description": "The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified.", "in": "BODY", "type": "string[]", "required": false, @@ -14174,7 +13176,7 @@ }, { "name": "repository_ids", - "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "description": "The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.", "in": "BODY", "type": "integer[]", "required": false, @@ -14187,7 +13189,7 @@ }, { "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", + "description": "The permissions granted to the user access token.", "in": "BODY", "type": "object", "required": false, @@ -14676,7 +13678,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#suspend-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -14710,7 +13712,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/apps#unsuspend-an-app-installation", "previews": [], "headers": [], "parameters": [ @@ -14744,7 +13746,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/apps/webhooks#update-a-webhook-configuration-for-an-app", "previews": [], "headers": [], "parameters": [ @@ -14824,7 +13826,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -14865,7 +13867,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -14906,7 +13908,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -14947,7 +13949,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -14988,7 +13990,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -15029,7 +14031,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -15089,7 +14091,7 @@ }, { "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "description": "The name of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -15100,13 +14102,65 @@ "alias": null, "deprecated": null }, + { + "name": "name", + "description": "The name of the check. For example, \"code-coverage\".", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "head_sha", + "description": "The SHA of the commit.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "details_url", + "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "external_id", + "description": "A reference for the run on the integrator's system.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "status", - "description": "", + "description": "The current status.", "in": "BODY", - "type": null, + "type": "string", "required": false, - "enum": ["queued", "in_progress"], + "enum": ["queued", "in_progress", "completed"], "allowNull": false, "mapToData": null, "validation": null, @@ -15114,8 +14168,56 @@ "deprecated": null }, { - "name": "*", - "description": "", + "name": "started_at", + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "conclusion", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", + "in": "BODY", + "type": "string", + "required": false, + "enum": [ + "action_required", + "cancelled", + "failure", + "neutral", + "success", + "skipped", + "stale", + "timed_out" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "completed_at", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "in": "BODY", "type": "object", "required": false, @@ -15125,6 +14227,279 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "output.title", + "description": "The title of the check run.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.summary", + "description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.text", + "description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].path", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].start_line", + "description": "The start line of the annotation. Line numbers start at 1.", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].end_line", + "description": "The end line of the annotation.", + "in": "BODY", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].start_column", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].end_column", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].annotation_level", + "description": "The level of the annotation.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["notice", "warning", "failure"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].title", + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.annotations[].raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images", + "description": "Adds images to the output displayed in the GitHub pull request UI.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images[].alt", + "description": "The alternative text for the image.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images[].image_url", + "description": "The full URL of the image.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images[].caption", + "description": "A short image description.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "actions", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "actions[].label", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "actions[].description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "actions[].identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -15152,8 +14527,8 @@ "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", + "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/checks/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/checks/suites#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/checks/suites#create-a-check-suite", "previews": [], "headers": [], "parameters": [ @@ -15228,8 +14603,8 @@ "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", + "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/checks/runs#get-a-check-run", "previews": [], "headers": [], "parameters": [ @@ -15295,8 +14670,8 @@ "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", + "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/checks/suites#get-a-check-suite", "previews": [], "headers": [], "parameters": [ @@ -15362,8 +14737,8 @@ "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", + "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/checks/runs#list-check-run-annotations", "previews": [], "headers": [], "parameters": [ @@ -15455,8 +14830,8 @@ "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", + "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/checks/runs#list-check-runs-for-a-git-reference", "previews": [], "headers": [], "parameters": [ @@ -15488,7 +14863,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -15600,8 +14975,8 @@ "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", + "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/checks/runs#list-check-runs-in-a-check-suite", "previews": [], "headers": [], "parameters": [ @@ -15732,8 +15107,8 @@ "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", + "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/checks/suites#list-check-suites-for-a-git-reference", "previews": [], "headers": [], "parameters": [ @@ -15765,7 +15140,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -15851,8 +15226,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, 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-run", + "description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.\n\nFor more information about how to re-run GitHub Actions jobs, see \"[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)\".", + "documentationUrl": "https://docs.github.com/rest/checks/runs#rerequest-a-check-run", "previews": [], "headers": [], "parameters": [ @@ -15925,8 +15300,8 @@ "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", + "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:write` permission on a private repository or pull access to a public repository.", + "documentationUrl": "https://docs.github.com/rest/checks/suites#rerequest-a-check-suite", "previews": [], "headers": [], "parameters": [ @@ -15988,8 +15363,8 @@ "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", + "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/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "documentationUrl": "https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites", "previews": [], "headers": [], "parameters": [ @@ -16082,7 +15457,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/checks/runs#update-a-check-run", "previews": [], "headers": [], "parameters": [ @@ -16279,7 +15654,7 @@ }, { "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".", "in": "BODY", "type": "object[]", "required": false, @@ -16461,7 +15836,7 @@ }, { "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions).\"", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).\"", "in": "BODY", "type": "object[]", "required": false, @@ -16535,7 +15910,7 @@ "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` scope.\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* `category`\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`next_analysis_url` and `confirm_delete_url`.\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin a 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 an analysis that's identified as deletable.\nEach set of analyses always has one that's identified as deletable.\nHaving found the deletable analysis for one of the two sets,\ndelete this analysis and then continue deleting the next analysis in the set until they're all deleted.\nThen 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", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository", "previews": [], "headers": [], "parameters": [ @@ -16624,7 +15999,7 @@ "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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -16712,7 +16087,7 @@ "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 with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\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).", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -16795,7 +16170,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-codeql-database-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -16870,7 +16245,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a code scanning default setup configuration.\nYou must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`\nscope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/code-scanning#get-a-code-scanning-default-setup-configuration", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration", "previews": [], "headers": [], "parameters": [ @@ -16907,7 +16282,7 @@ "description": "Response", "examples": [ { - "data": "{\"state\":\"configured\",\"languages\":[\"ruby\",\"javascript\",\"python\"],\"query_suite\":\"default\",\"updated_at\":\"2023-01-19T11:21:34Z\"}" + "data": "{\"state\":\"configured\",\"languages\":[\"ruby\",\"python\"],\"query_suite\":\"default\",\"updated_at\":\"2023-01-19T11:21:34Z\",\"schedule\":\"weekly\"}" } ] }, @@ -16930,8 +16305,8 @@ "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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-information-about-a-sarif-upload", + "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/code-scanning/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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload", "previews": [], "headers": [], "parameters": [ @@ -17009,7 +16384,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub 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", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -17122,7 +16497,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -17469,7 +16844,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub 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", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -17587,7 +16962,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the CodeQL databases that are available in a repository.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -17648,7 +17023,7 @@ "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 with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\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", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -17813,7 +17188,7 @@ "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 with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. 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", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -17926,7 +17301,7 @@ "deprecationDate": null, "removalDate": null, "description": "Updates a code scanning default setup configuration.\nYou must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo`\nscope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/code-scanning#update-a-code-scanning-default-setup-configuration", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration", "previews": [], "headers": [], "parameters": [ @@ -17981,10 +17356,27 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "languages", + "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 202, "description": "Response", @@ -18018,8 +17410,8 @@ "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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. 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 number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in 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-an-analysis-as-sarif-data", + "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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\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 number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 20 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"", + "documentationUrl": "https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data", "previews": [], "headers": [], "parameters": [ @@ -18180,8 +17572,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-all-codes-of-conduct", + "description": "Returns array of all GitHub's codes of conduct.", + "documentationUrl": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct", "previews": [], "headers": [], "parameters": [], @@ -18208,8 +17600,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-a-code-of-conduct", + "description": "Returns information about the specified GitHub code of conduct.", + "documentationUrl": "https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct", "previews": [], "headers": [], "parameters": [ @@ -18252,7 +17644,7 @@ "deprecationDate": null, "removalDate": null, "description": "Adds a repository to the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret", "previews": [], "headers": [], "parameters": [ @@ -18309,8 +17701,8 @@ "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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#add-selected-repository-to-an-organization-secret", + "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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -18384,7 +17776,7 @@ "deprecationDate": null, "removalDate": null, "description": "List the machine types a codespace can transition to use.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-machine-types-for-a-codespace", + "documentationUrl": "https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace", "previews": [], "headers": [], "parameters": [ @@ -18408,7 +17800,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":8}]}" + "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 32 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":34359738368,\"cpus\":8}]}" } ] }, @@ -18434,7 +17826,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a new codespace, owned by the authenticated user.\n\nThis endpoint requires either a `repository_id` OR a `pull_request` but not both.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -18640,7 +18032,7 @@ "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -18649,7 +18041,7 @@ "description": "Response when the codespace creation partially failed but is being retried in the background", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -18673,8 +18065,8 @@ "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.\n\n**Example encrypting a secret using Node.js**\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n**Example encrypting a secret using Python**\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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/codespaces#create-or-update-an-organization-secret", + "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). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -18706,7 +18098,7 @@ }, { "name": "encrypted_value", - "description": "The 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 organization public key](https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key) endpoint.", + "description": "The 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 organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -18745,7 +18137,7 @@ }, { "name": "selected_repository_ids", - "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 manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints.", + "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 manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": false, @@ -18786,8 +18178,8 @@ "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 write access to the `codespaces_secrets`\nrepository permission to use this endpoint.\n\n#### Example of encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example of encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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 of 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 of 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/codespaces#create-or-update-a-repository-secret", + "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). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`\nrepository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -18832,7 +18224,7 @@ }, { "name": "encrypted_value", - "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 a repository public key](https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key) endpoint.", + "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 a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -18880,8 +18272,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.\n\n**Example encrypting a secret using Node.js**\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n**Example encrypting a secret using Python**\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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/codespaces#create-or-update-a-secret-for-the-authenticated-user", + "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -18900,7 +18292,7 @@ }, { "name": "encrypted_value", - "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 the public key for the authenticated user](https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user) endpoint.", + "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 the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -18926,7 +18318,7 @@ }, { "name": "selected_repository_ids", - "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "in": "BODY", "type": "undefined[]", "required": false, @@ -18968,7 +18360,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a codespace owned by the authenticated user for the specified pull request.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-from-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -19148,7 +18540,7 @@ "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -19157,7 +18549,7 @@ "description": "Response when the codespace creation partially failed but is being retried in the background", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -19182,7 +18574,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a codespace owned by the authenticated user in the specified repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-a-codespace-in-a-repository", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository", "previews": [], "headers": [], "parameters": [ @@ -19362,7 +18754,7 @@ "description": "Response when the codespace was successfully created", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -19371,7 +18763,7 @@ "description": "Response when the codespace creation partially failed but is being retried in the background", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -19389,16 +18781,16 @@ "renamed": null }, { - "name": "Removes users from Codespaces billing for an organization", + "name": "Remove users from Codespaces access for an organization", "scope": "codespaces", - "id": "deleteCodespacesBillingUsers", + "id": "deleteCodespacesAccessUsers", "method": "DELETE", - "url": "/orgs/{org}/codespaces/billing/selected_users", - "isDeprecated": false, + "url": "/orgs/{org}/codespaces/access/selected_users", + "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Codespaces for the specified users will no longer be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-codespaces-billing-users", + "description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -19461,7 +18853,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-codespace-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -19507,7 +18899,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a user's codespace.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization", "previews": [], "headers": [], "parameters": [ @@ -19579,7 +18971,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -19626,7 +19018,7 @@ "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 write access to the `codespaces_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -19683,7 +19075,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-secret-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -19768,7 +19160,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the codespaces that a member of an organization has for repositories in that 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/codespaces#get-codespaces-for-user-in-org", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-a-user-in-organization", "previews": [], "headers": [], "parameters": [ @@ -19831,7 +19223,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" + "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" } ] }, @@ -19912,7 +19304,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-codespace-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -19936,7 +19328,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -19962,7 +19354,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of 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.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-an-organization-public-key", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key", "previews": [], "headers": [], "parameters": [ @@ -20003,7 +19395,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets an organization secret without revealing its encrypted value.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -20057,7 +19449,7 @@ "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.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-public-key-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [], @@ -20084,7 +19476,7 @@ "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 write access to the `codespaces_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key", + "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key", "previews": [], "headers": [], "parameters": [ @@ -20138,7 +19530,7 @@ "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 write access to the `codespaces_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -20205,7 +19597,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a secret available to a user's codespaces without revealing its encrypted value.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-secret-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -20246,7 +19638,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files\nspecify launchpoint configurations for codespaces created within the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-devcontainers-in-a-repository-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-devcontainer-configurations-in-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -20336,7 +19728,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the authenticated user's codespaces.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-codespaces-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -20386,7 +19778,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" + "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" } ] }, @@ -20412,7 +19804,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the codespaces associated to a specified 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/codespaces#list-in-organization", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization", "previews": [], "headers": [], "parameters": [ @@ -20475,7 +19867,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" + "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}" } ] }, @@ -20501,7 +19893,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the codespaces associated to a specified repository and the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#list-codespaces-in-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -20564,7 +19956,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":2,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]}]}" + "data": "{\"total_count\":2,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":2,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]}]}" } ] }, @@ -20589,7 +19981,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all Codespaces secrets available at the organization-level without revealing their encrypted values.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-organization-secrets", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets", "previews": [], "headers": [], "parameters": [ @@ -20656,7 +20048,7 @@ "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 write access to the `codespaces_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-repository-secrets", + "documentationUrl": "https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets", "previews": [], "headers": [], "parameters": [ @@ -20736,7 +20128,7 @@ "deprecationDate": null, "removalDate": null, "description": "List the repositories that have been granted the ability to use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret", "previews": [], "headers": [], "parameters": [ @@ -20785,7 +20177,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all secrets available for a user's Codespaces without revealing their\nencrypted values.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-secrets-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#list-secrets-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -20839,7 +20231,7 @@ "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.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -20920,7 +20312,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the default attributes for codespaces created by the user with the repository.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#preview-attributes-for-a-new-codespace", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace", "previews": [], "headers": [], "parameters": [ @@ -20983,7 +20375,7 @@ "description": "Response when a user is able to create codespaces from the repository.", "examples": [ { - "data": "{\"devcontainers\":[{\"path\":\".devcontainer/foobar/devcontainer.json\",\"name\":\"foobar\",\"display_name\":\"foobar\"},{\"path\":\".devcontainer/devcontainer.json\",\"name\":\"kitchensink\",\"display_name\":\"kitchensink\"},{\"path\":\".devcontainer.json\",\"display_name\":\"Default project configuration\"}],\"total_count\":3}" + "data": "{\"billable_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},\"defaults\":{\"location\":\"EastUs\",\"devcontainer_path\":\".devcontainer/devcontainer.json\"}}" } ] }, @@ -21007,7 +20399,7 @@ "deprecationDate": null, "removalDate": null, "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace", "previews": [], "headers": [], "parameters": [ @@ -21057,7 +20449,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"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,\"allow_forking\":true,\"subscribers_count\":42,\"network_count\":0,\"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}},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"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,\"allow_forking\":true,\"subscribers_count\":42,\"network_count\":0,\"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}},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" } ] }, @@ -21086,7 +20478,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes a repository from the selected repositories for a user's codespace secret.\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret", "previews": [], "headers": [], "parameters": [ @@ -21143,8 +20535,8 @@ "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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret", + "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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -21218,7 +20610,7 @@ "deprecationDate": null, "removalDate": null, "description": "List the machine types available for a given repository based on its configuration.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-available-machine-types-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -21273,6 +20665,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "ref", + "description": "The branch or commit to check for prebuild availability and devcontainer restrictions.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -21281,7 +20686,7 @@ "description": "Response", "examples": [ { - "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":8}]}" + "data": "{\"total_count\":2,\"machines\":[{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},{\"name\":\"premiumLinux\",\"display_name\":\"8 cores, 32 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":34359738368,\"cpus\":8}]}" } ] }, @@ -21300,14 +20705,14 @@ { "name": "Manage access control for organization codespaces", "scope": "codespaces", - "id": "setCodespacesBilling", + "id": "setCodespacesAccess", "method": "PUT", - "url": "/orgs/{org}/codespaces/billing", - "isDeprecated": false, + "url": "/orgs/{org}/codespaces/access", + "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing", + "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces", "previews": [], "headers": [], "parameters": [ @@ -21379,16 +20784,16 @@ "renamed": null }, { - "name": "Add users to Codespaces billing for an organization", + "name": "Add users to Codespaces access for an organization", "scope": "codespaces", - "id": "setCodespacesBillingUsers", + "id": "setCodespacesAccessUsers", "method": "POST", - "url": "/orgs/{org}/codespaces/billing/selected_users", - "isDeprecated": false, + "url": "/orgs/{org}/codespaces/access/selected_users", + "isDeprecated": true, "deprecationDate": null, "removalDate": null, - "description": "Codespaces for the specified users will be billed to the organization.\nTo use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing-users", + "description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21451,7 +20856,7 @@ "deprecationDate": null, "removalDate": null, "description": "Select the repositories that will use a user's codespace secret.\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-a-user-secret", + "documentationUrl": "https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret", "previews": [], "headers": [], "parameters": [ @@ -21470,7 +20875,7 @@ }, { "name": "selected_repository_ids", - "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/reference/codespaces#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/reference/codespaces#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/reference/codespaces#remove-a-selected-repository-from-a-user-secret) endpoints.", + "description": "An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -21508,8 +20913,465 @@ "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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-selected-repositories-for-an-organization-secret", + "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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "secret_name", + "description": "The name of the secret.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "selected_repository_ids", + "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/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints.", + "in": "BODY", + "type": "integer[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { "code": 204, "description": "Response", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 409, + "description": "Conflict when visibility type not set to selected", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Start a codespace for the authenticated user", + "scope": "codespaces", + "id": "startForAuthenticatedUser", + "method": "POST", + "url": "/user/codespaces/{codespace_name}/start", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Starts a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 402, "description": "Payment required", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 409, "description": "Conflict", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Stop a codespace for the authenticated user", + "scope": "codespaces", + "id": "stopForAuthenticatedUser", + "method": "POST", + "url": "/user/codespaces/{codespace_name}/stop", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Stop a codespace for an organization user", + "scope": "codespaces", + "id": "stopInOrganization", + "method": "POST", + "url": "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + } + ] + }, + { "code": 304, "description": "Not modified", "examples": null }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Update a codespace for the authenticated user", + "scope": "codespaces", + "id": "updateForAuthenticatedUser", + "method": "PATCH", + "url": "/user/codespaces/{codespace_name}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "codespace_name", + "description": "The name of the codespace.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "machine", + "description": "A valid machine to transition this codespace to.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "display_name", + "description": "Display name for this codespace", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "recent_folders", + "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 16 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":17179869184,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + } + ] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Add teams to the Copilot for Business subscription for an organization", + "scope": "copilot", + "id": "addCopilotForBusinessSeatsForTeams", + "method": "POST", + "url": "/orgs/{org}/copilot/billing/selected_teams", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note**: This endpoint is in beta and is subject to change.\n\n Purchases a GitHub Copilot for Business seat for all users within each specified team.\n The organization will be billed accordingly. For more information about Copilot for Business pricing, see \"[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)\".\n\n Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\n authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.\n\n In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\n For more information about setting up a Copilot for Business subscription, see \"[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)\".\n For more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "selected_teams", + "description": "List of team names within the organization to which to grant access to GitHub Copilot.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "OK", + "examples": [{ "data": "{\"seats_created\":5}" }] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Add users to the Copilot for Business subscription for an organization", + "scope": "copilot", + "id": "addCopilotForBusinessSeatsForUsers", + "method": "POST", + "url": "/orgs/{org}/copilot/billing/selected_users", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nPurchases a GitHub Copilot for Business seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot for Business pricing, see \"[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.\n\nIn order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot for Business subscription, see \"[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)\".\nFor more information about setting a suggestion matching policy, see \"[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)\".", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "selected_usernames", + "description": "The usernames of the organization members to be granted access to GitHub Copilot.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "OK", + "examples": [{ "data": "{\"seats_created\":5}" }] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", + "examples": null + }, + { "code": 500, "description": "Internal Error", "examples": null } + ], + "renamed": null + }, + { + "name": "Remove teams from the Copilot for Business subscription for an organization", + "scope": "copilot", + "id": "cancelCopilotSeatAssignmentForTeams", + "method": "DELETE", + "url": "/orgs/{org}/copilot/billing/selected_teams", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot for Business seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot for Business pricing, see \"[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)\".\n\nFor more information about disabling access to Copilot for Business, see \"[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -21527,23 +21389,10 @@ "deprecated": null }, { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "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/codespaces#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/codespaces#remove-selected-repository-from-an-organization-secret) endpoints.", + "name": "selected_teams", + "description": "The names of teams from which to revoke access to GitHub Copilot.", "in": "BODY", - "type": "integer[]", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -21554,33 +21403,44 @@ } ], "responses": [ - { "code": 204, "description": "Response", "examples": null }, + { + "code": 200, + "description": "OK", + "examples": [{ "data": "{\"seats_cancelled\":5}" }] + }, + { + "code": 401, + "description": "Requires authentication", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, { - "code": 409, - "description": "Conflict when visibility type not set to selected", + "code": 422, + "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.", "examples": null - } + }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Start a codespace for the authenticated user", - "scope": "codespaces", - "id": "startForAuthenticatedUser", - "method": "POST", - "url": "/user/codespaces/{codespace_name}/start", + "name": "Remove users from the Copilot for Business subscription for an organization", + "scope": "copilot", + "id": "cancelCopilotSeatAssignmentForUsers", + "method": "DELETE", + "url": "/orgs/{org}/copilot/billing/selected_users", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Starts a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#start-a-codespace-for-the-authenticated-user", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nCancels the Copilot for Business seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.\n\nFor more information about Copilot for Business pricing, see \"[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)\"\n\nFor more information about disabling access to Copilot for Business, see \"[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "codespace_name", - "description": "The name of the codespace.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21590,51 +21450,60 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "selected_usernames", + "description": "The usernames of the organization members for which to revoke access to GitHub Copilot.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" - } - ] + "description": "OK", + "examples": [{ "data": "{\"seats_cancelled\":5}" }] }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, { "code": 401, "description": "Requires authentication", "examples": null }, - { "code": 402, "description": "Payment required", "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, + { + "code": 422, + "description": "Copilot for Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.", + "examples": null + }, { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Stop a codespace for the authenticated user", - "scope": "codespaces", - "id": "stopForAuthenticatedUser", - "method": "POST", - "url": "/user/codespaces/{codespace_name}/stop", + "name": "Get Copilot for Business seat information and settings for an organization", + "scope": "copilot", + "id": "getCopilotOrganizationDetails", + "method": "GET", + "url": "/orgs/{org}/copilot/billing", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#stop-a-codespace-for-the-authenticated-user", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets information about an organization's Copilot for Business subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)\".\n\nOnly organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "codespace_name", - "description": "The name of the codespace.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21649,10 +21518,10 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "OK", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"seat_breakdown\":{\"total\":12,\"added_this_cycle\":9,\"pending_invitation\":0,\"pending_cancellation\":0,\"active_this_cycle\":12,\"inactive_this_cycle\":11},\"seat_management_setting\":\"assign_selected\",\"public_code_suggestions\":\"block\"}" } ] }, @@ -21668,16 +21537,16 @@ "renamed": null }, { - "name": "Stop a codespace for an organization user", - "scope": "codespaces", - "id": "stopInOrganization", - "method": "POST", - "url": "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop", + "name": "Get Copilot for Business seat assignment details for a user", + "scope": "copilot", + "id": "getCopilotSeatAssignmentDetailsForUser", + "method": "GET", + "url": "/orgs/{org}/members/{username}/copilot", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Stops a user's codespace.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nGets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.\n\nOrganization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -21706,32 +21575,18 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "codespace_name", - "description": "The name of the codespace.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { "code": 200, - "description": "Response", + "description": "The user's GitHub Copilot seat details, including usage.", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"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},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}" } ] }, - { "code": 304, "description": "Not modified", "examples": null }, { "code": 401, "description": "Requires authentication", @@ -21739,27 +21594,32 @@ }, { "code": 403, "description": "Forbidden", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Copilot for Business is not enabled for this organization or the user has a pending organization invitation.", + "examples": null + }, { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, { - "name": "Update a codespace for the authenticated user", - "scope": "codespaces", - "id": "updateForAuthenticatedUser", - "method": "PATCH", - "url": "/user/codespaces/{codespace_name}", + "name": "List all Copilot for Business seat assignments for an organization", + "scope": "copilot", + "id": "listCopilotSeats", + "method": "GET", + "url": "/orgs/{org}/copilot/billing/seats", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint.\n\nIf you specify a new machine type it will be applied the next time your codespace is started.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/codespaces#update-a-codespace-for-the-authenticated-user", + "description": "**Note**: This endpoint is in beta and is subject to change.\n\nLists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).\n\nOnly organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must\nauthenticate using an access token with the `manage_billing:copilot` scope to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "codespace_name", - "description": "The name of the codespace.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -21771,23 +21631,10 @@ "deprecated": null }, { - "name": "machine", - "description": "A valid machine to transition this codespace to.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "display_name", - "description": "Display name for this codespace", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -21797,10 +21644,10 @@ "deprecated": null }, { - "name": "recent_folders", - "description": "Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in.", - "in": "BODY", - "type": "string[]", + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -21816,7 +21663,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"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},\"billable_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},\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}" + "data": "{\"total_seats\":2,\"seats\":[{\"created_at\":\"2021-08-03T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":null,\"last_activity_at\":\"2021-10-14T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"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},\"assigning_team\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}},{\"created_at\":\"2021-09-23T18:00:00-06:00\",\"updated_at\":\"2021-09-23T15:00:00-06:00\",\"pending_cancellation_date\":\"2021-11-01\",\"last_activity_at\":\"2021-10-13T00:53:32-06:00\",\"last_activity_editor\":\"vscode/1.77.3/copilot/1.86.82\",\"assignee\":{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ76VNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] }, @@ -21826,7 +21673,8 @@ "examples": null }, { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 500, "description": "Internal Error", "examples": null } ], "renamed": null }, @@ -21839,8 +21687,8 @@ "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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#add-selected-repository-to-an-organization-secret", + "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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -22014,8 +21862,8 @@ "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 `dependabot_secrets` repository\npermission to use this endpoint.\n\n**Example encrypting a secret using Node.js**\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n**Example encrypting a secret using Python**\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/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/dependabot#create-or-update-a-repository-secret", + "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). For more information, see \"[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api).\"\n\nYou must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -22060,7 +21908,7 @@ }, { "name": "encrypted_value", - "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 a repository public key](https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key) endpoint.", + "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 a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -22109,7 +21957,7 @@ "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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#delete-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -22153,7 +22001,7 @@ "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 `dependabot_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#delete-a-repository-secret", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -22210,7 +22058,7 @@ "deprecationDate": null, "removalDate": null, "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-dependabot-alert", + "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert", "previews": [], "headers": [], "parameters": [ @@ -22280,7 +22128,7 @@ "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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key", "previews": [], "headers": [], "parameters": [ @@ -22321,7 +22169,7 @@ "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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -22375,7 +22223,7 @@ "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 `dependabot_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key", "previews": [], "headers": [], "parameters": [ @@ -22429,7 +22277,7 @@ "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 `dependabot_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-secret", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret", "previews": [], "headers": [], "parameters": [ @@ -22908,7 +22756,7 @@ "deprecationDate": null, "removalDate": null, "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-dependabot-alerts-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -23154,7 +23002,7 @@ "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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-organization-secrets", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-organization-secrets", "previews": [], "headers": [], "parameters": [ @@ -23221,7 +23069,7 @@ "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 `dependabot_secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-repository-secrets", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-repository-secrets", "previews": [], "headers": [], "parameters": [ @@ -23301,7 +23149,7 @@ "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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -23380,8 +23228,8 @@ "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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret", + "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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -23448,8 +23296,8 @@ "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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret", + "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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint.", + "documentationUrl": "https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret", "previews": [], "headers": [], "parameters": [ @@ -23481,7 +23329,7 @@ }, { "name": "selected_repository_ids", - "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/dependabot#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.", + "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/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -23506,7 +23354,7 @@ "deprecationDate": null, "removalDate": null, "description": "You must use an access token with the `security_events` scope to use this endpoint with private repositories.\nYou can also use tokens with the `public_repo` scope for public repositories only.\nGitHub Apps must have **Dependabot alerts** write permission to use this endpoint.\n\nTo use this endpoint, you must have access to security alerts for the repository. For more information, see \"[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts).\"", - "documentationUrl": "https://docs.github.com/rest/reference/dependabot#update-a-dependabot-alert", + "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert", "previews": [], "headers": [], "parameters": [ @@ -23628,7 +23476,7 @@ "deprecationDate": null, "removalDate": null, "description": "Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to.", - "documentationUrl": "https://docs.github.com/rest/reference/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -24059,7 +23907,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits.", - "documentationUrl": "https://docs.github.com/rest/reference/dependency-graph#get-a-diff-of-the-dependencies-between-commits", + "documentationUrl": "https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits", "previews": [], "headers": [], "parameters": [ @@ -24126,7 +23974,11 @@ } ] }, - { "code": 403, "description": "Forbidden", "examples": null }, + { + "code": 403, + "description": "Response if GitHub Advanced Security is not enabled for this repository", + "examples": null + }, { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null @@ -24178,7 +24030,7 @@ "description": "Response", "examples": [ { - "data": "{\"sbom\":{\"SPDXID\":\"SPDXRef-DOCUMENT\",\"spdxVersion\":\"SPDX-2.3\",\"creationInfo\":{\"created\":\"2021-09-01T00:00:00Z\",\"creators\":[\"Tool: GitHub.com-Dependency-Graph\"]},\"name\":\"github/example\",\"dataLicense\":\"CC0-1.0\",\"documentDescribes\":[\"github/example\"],\"documentNamespace\":\"https://github.com/github/example/dependency_graph/sbom-abcdef123456\",\"packages\":[{\"SPDXID\":\"SPDXRef-Package\",\"name\":\"rubygems:rails\",\"versionInfo\":\"1.0.0\",\"downloadLocation\":\"NOASSERTION\",\"filesAnalyzed\":false,\"licenseConcluded\":\"NOASSERTION\",\"licenseDeclared\":\"NOASSERTION\"}]}}" + "data": "{\"sbom\":{\"SPDXID\":\"SPDXRef-DOCUMENT\",\"spdxVersion\":\"SPDX-2.3\",\"creationInfo\":{\"created\":\"2021-09-01T00:00:00Z\",\"creators\":[\"Tool: GitHub.com-Dependency-Graph\"]},\"name\":\"github/example\",\"dataLicense\":\"CC0-1.0\",\"documentDescribes\":[\"github/example\"],\"documentNamespace\":\"https://github.com/github/example/dependency_graph/sbom-abcdef123456\",\"packages\":[{\"SPDXID\":\"SPDXRef-Package\",\"name\":\"rubygems:rails\",\"versionInfo\":\"1.0.0\",\"downloadLocation\":\"NOASSERTION\",\"filesAnalyzed\":false,\"licenseConcluded\":\"MIT\",\"licenseDeclared\":\"MIT\"}]}}" } ] }, @@ -24197,7 +24049,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all the emojis available to use on GitHub.", - "documentationUrl": "https://docs.github.com/rest/reference/emojis#get-emojis", + "documentationUrl": "https://docs.github.com/rest/emojis/emojis#get-emojis", "previews": [], "headers": [], "parameters": [], @@ -24225,7 +24077,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#check-if-a-gist-is-starred", + "documentationUrl": "https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred", "previews": [], "headers": [], "parameters": [ @@ -24269,7 +24121,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gists/gists#create-a-gist", "previews": [], "headers": [], "parameters": [ @@ -24370,7 +24222,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#create-a-gist-comment", + "documentationUrl": "https://docs.github.com/rest/gists/comments#create-a-gist-comment", "previews": [], "headers": [], "parameters": [ @@ -24427,7 +24279,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#delete-a-gist", + "documentationUrl": "https://docs.github.com/rest/gists/gists#delete-a-gist", "previews": [], "headers": [], "parameters": [ @@ -24463,7 +24315,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#delete-a-gist-comment", + "documentationUrl": "https://docs.github.com/rest/gists/comments#delete-a-gist-comment", "previews": [], "headers": [], "parameters": [ @@ -24512,7 +24364,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#fork-a-gist", + "documentationUrl": "https://docs.github.com/rest/gists/gists#fork-a-gist", "previews": [], "headers": [], "parameters": [ @@ -24561,7 +24413,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist", + "documentationUrl": "https://docs.github.com/rest/gists/gists#get-a-gist", "previews": [], "headers": [], "parameters": [ @@ -24605,7 +24457,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist-comment", + "documentationUrl": "https://docs.github.com/rest/gists/comments#get-a-gist-comment", "previews": [], "headers": [], "parameters": [ @@ -24662,7 +24514,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#get-a-gist-revision", + "documentationUrl": "https://docs.github.com/rest/gists/gists#get-a-gist-revision", "previews": [], "headers": [], "parameters": [ @@ -24723,13 +24575,13 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -24792,7 +24644,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-comments", + "documentationUrl": "https://docs.github.com/rest/gists/comments#list-gist-comments", "previews": [], "headers": [], "parameters": [ @@ -24862,7 +24714,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-commits", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-gist-commits", "previews": [], "headers": [], "parameters": [ @@ -24932,7 +24784,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-gists-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -24951,7 +24803,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -25017,7 +24869,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#list-gist-forks", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-gist-forks", "previews": [], "headers": [], "parameters": [ @@ -25087,13 +24939,13 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-public-gists", "previews": [], "headers": [], "parameters": [ { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -25161,13 +25013,13 @@ "deprecationDate": null, "removalDate": null, "description": "List the authenticated user's starred gists:", - "documentationUrl": "https://docs.github.com/rest/reference/gists#list-starred-gists", + "documentationUrl": "https://docs.github.com/rest/gists/gists#list-starred-gists", "previews": [], "headers": [], "parameters": [ { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -25235,7 +25087,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gists/gists#star-a-gist", "previews": [], "headers": [], "parameters": [ @@ -25271,7 +25123,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#unstar-a-gist", + "documentationUrl": "https://docs.github.com/rest/gists/gists#unstar-a-gist", "previews": [], "headers": [], "parameters": [ @@ -25425,7 +25277,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/gists#update-a-gist-comment", + "documentationUrl": "https://docs.github.com/rest/gists/comments#update-a-gist-comment", "previews": [], "headers": [], "parameters": [ @@ -25493,7 +25345,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-blob", + "documentationUrl": "https://docs.github.com/rest/git/blobs#create-a-blob", "previews": [], "headers": [], "parameters": [ @@ -25580,8 +25432,8 @@ "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 the 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 their 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", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-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 the 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 their 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/git/commits#create-a-commit", "previews": [], "headers": [], "parameters": [ @@ -25797,7 +25649,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/git/refs#create-a-reference", "previews": [], "headers": [], "parameters": [ @@ -25881,8 +25733,8 @@ "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 their 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", + "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/git/refs#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/git/refs#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 their 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/git/tags#create-a-tag-object", "previews": [], "headers": [], "parameters": [ @@ -26044,8 +25896,8 @@ "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).\"\n\nReturns an error if you try to delete a file that does not exist.", - "documentationUrl": "https://docs.github.com/rest/reference/git#create-a-tree", + "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/git/commits#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", + "documentationUrl": "https://docs.github.com/rest/git/trees#create-a-tree", "previews": [], "headers": [], "parameters": [ @@ -26197,7 +26049,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/git#delete-a-reference", + "documentationUrl": "https://docs.github.com/rest/git/refs#delete-a-reference", "previews": [], "headers": [], "parameters": [ @@ -26229,7 +26081,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -26261,7 +26113,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/git/blobs#get-a-blob", "previews": [], "headers": [], "parameters": [ @@ -26326,7 +26178,7 @@ "renamed": null }, { - "name": "Get a commit", + "name": "Get a commit object", "scope": "git", "id": "getCommit", "method": "GET", @@ -26334,8 +26186,8 @@ "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 the 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 their 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", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects).\n\nTo get the contents of a commit, see \"[Get a commit](/rest/commits/commits#get-a-commit).\"\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 the 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 their 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/git/commits#get-a-commit-object", "previews": [], "headers": [], "parameters": [ @@ -26402,8 +26254,8 @@ "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", + "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/pulls/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/git/refs#get-a-reference", "previews": [], "headers": [], "parameters": [ @@ -26435,7 +26287,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -26471,7 +26323,7 @@ "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 their 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", + "documentationUrl": "https://docs.github.com/rest/git/tags#get-a-tag", "previews": [], "headers": [], "parameters": [ @@ -26538,8 +26390,8 @@ "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.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", - "documentationUrl": "https://docs.github.com/rest/reference/git#get-a-tree", + "description": "Returns a single tree using the SHA1 value or ref name 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.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", + "documentationUrl": "https://docs.github.com/rest/git/trees#get-a-tree", "previews": [], "headers": [], "parameters": [ @@ -26571,7 +26423,7 @@ }, { "name": "tree_sha", - "description": "", + "description": "The SHA1 value or ref (branch or tag) name of the tree.", "in": "PATH", "type": "string", "required": true, @@ -26627,8 +26479,8 @@ "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", + "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/pulls/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/git/refs#list-matching-references", "previews": [], "headers": [], "parameters": [ @@ -26660,7 +26512,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -26695,7 +26547,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/git#update-a-reference", + "documentationUrl": "https://docs.github.com/rest/git/refs#update-a-reference", "previews": [], "headers": [], "parameters": [ @@ -26727,7 +26579,7 @@ }, { "name": "ref", - "description": "The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected.", + "description": "The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -26792,8 +26644,8 @@ "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", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user).", + "documentationUrl": "https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates", "previews": [], "headers": [], "parameters": [], @@ -26821,7 +26673,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/gitignore/gitignore#get-a-gitignore-template", "previews": [], "headers": [], "parameters": [ @@ -26863,7 +26715,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories", "previews": [], "headers": [], "parameters": [], @@ -26895,7 +26747,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -26936,7 +26788,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -26990,7 +26842,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#get-interaction-restrictions-for-your-public-repositories", "previews": [], "headers": [], "parameters": [], @@ -27033,7 +26885,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories", "previews": [], "headers": [], "parameters": [], @@ -27050,7 +26902,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -27081,7 +26933,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -27128,7 +26980,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#remove-interaction-restrictions-from-your-public-repositories", "previews": [], "headers": [], "parameters": [], @@ -27156,7 +27008,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories", "previews": [], "headers": [], "parameters": [ @@ -27221,7 +27073,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -27299,7 +27151,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -27386,7 +27238,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/interactions/user#set-interaction-restrictions-for-your-public-repositories", "previews": [], "headers": [], "parameters": [ @@ -27462,7 +27314,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue", "previews": [], "headers": [], "parameters": [ @@ -27542,7 +27394,7 @@ "deprecationDate": null, "removalDate": null, "description": "Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. ", - "documentationUrl": "https://docs.github.com/rest/reference/issues#add-labels-to-an-issue", + "documentationUrl": "https://docs.github.com/rest/issues/labels#add-labels-to-an-issue", "previews": [], "headers": [], "parameters": [ @@ -27643,7 +27495,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned", "previews": [], "headers": [], "parameters": [ @@ -27711,7 +27563,7 @@ "deprecationDate": null, "removalDate": null, "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code 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-to-a-issue", + "documentationUrl": "https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue", "previews": [], "headers": [], "parameters": [ @@ -27792,7 +27644,7 @@ "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://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis 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/issues#create-an-issue", + "documentationUrl": "https://docs.github.com/rest/issues/issues#create-an-issue", "previews": [], "headers": [], "parameters": [ @@ -27935,7 +27787,7 @@ "deprecationDate": null, "removalDate": null, "description": "\nYou can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nSee \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\"\nand \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\"\nfor details.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#create-an-issue-comment", + "documentationUrl": "https://docs.github.com/rest/issues/comments#create-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -28023,7 +27875,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/).", - "documentationUrl": "https://docs.github.com/rest/reference/issues#create-a-label", + "documentationUrl": "https://docs.github.com/rest/issues/labels#create-a-label", "previews": [], "headers": [], "parameters": [ @@ -28122,7 +27974,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a milestone.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#create-a-milestone", + "documentationUrl": "https://docs.github.com/rest/issues/milestones#create-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -28234,7 +28086,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-an-issue-comment", + "documentationUrl": "https://docs.github.com/rest/issues/comments#delete-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -28291,7 +28143,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a label using the given label name.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-a-label", + "documentationUrl": "https://docs.github.com/rest/issues/labels#delete-a-label", "previews": [], "headers": [], "parameters": [ @@ -28348,7 +28200,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a milestone using the given milestone number.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#delete-a-milestone", + "documentationUrl": "https://docs.github.com/rest/issues/milestones#delete-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -28407,8 +28259,8 @@ "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://docs.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 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", + "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://docs.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 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/pulls/pulls#list-pull-requests)\" endpoint.", + "documentationUrl": "https://docs.github.com/rest/issues/issues#get-an-issue", "previews": [], "headers": [], "parameters": [ @@ -28479,7 +28331,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue-comment", + "documentationUrl": "https://docs.github.com/rest/issues/comments#get-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -28547,7 +28399,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a single event by the event id.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue-event", + "documentationUrl": "https://docs.github.com/rest/issues/events#get-an-issue-event", "previews": [], "headers": [], "parameters": [ @@ -28617,7 +28469,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a label using the given name.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#get-a-label", + "documentationUrl": "https://docs.github.com/rest/issues/labels#get-a-label", "previews": [], "headers": [], "parameters": [ @@ -28685,7 +28537,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a milestone using the given milestone number.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#get-a-milestone", + "documentationUrl": "https://docs.github.com/rest/issues/milestones#get-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -28752,8 +28604,8 @@ "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 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", + "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 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/pulls/pulls#list-pull-requests)\" endpoint.", + "documentationUrl": "https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -28831,7 +28683,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -28951,7 +28803,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the [available assignees](https://docs.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", + "documentationUrl": "https://docs.github.com/rest/issues/assignees#list-assignees", "previews": [], "headers": [], "parameters": [ @@ -29032,7 +28884,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.\n\nIssue comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-comments", + "documentationUrl": "https://docs.github.com/rest/issues/comments#list-issue-comments", "previews": [], "headers": [], "parameters": [ @@ -29077,7 +28929,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -29140,7 +28992,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.\n\nBy default, issue comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-comments-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -29198,7 +29050,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -29265,7 +29117,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all events for an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-events", + "documentationUrl": "https://docs.github.com/rest/issues/events#list-issue-events", "previews": [], "headers": [], "parameters": [ @@ -29359,7 +29211,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists events for a repository.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-issue-events-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -29444,7 +29296,7 @@ "deprecationDate": null, "removalDate": null, "description": "List all timeline events for an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-timeline-events-for-an-issue", + "documentationUrl": "https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -29538,8 +29390,8 @@ "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 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", + "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API 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/pulls/pulls#list-pull-requests)\" endpoint.", + "documentationUrl": "https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -29617,7 +29469,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -29679,8 +29531,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API 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", + "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API 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/pulls/pulls#list-pull-requests)\" endpoint.", + "documentationUrl": "https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -29771,7 +29623,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -29832,8 +29684,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API 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", + "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API 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/pulls/pulls#list-pull-requests)\" endpoint.", + "documentationUrl": "https://docs.github.com/rest/issues/issues#list-repository-issues", "previews": [], "headers": [], "parameters": [ @@ -29969,7 +29821,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -30037,7 +29889,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists labels for issues in a milestone.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-issues-in-a-milestone", + "documentationUrl": "https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -30130,7 +29982,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all labels for a repository.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/issues/labels#list-labels-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -30211,7 +30063,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all labels for an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-labels-for-an-issue", + "documentationUrl": "https://docs.github.com/rest/issues/labels#list-labels-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30307,7 +30159,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists milestones for a repository.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#list-milestones", + "documentationUrl": "https://docs.github.com/rest/issues/milestones#list-milestones", "previews": [], "headers": [], "parameters": [ @@ -30427,7 +30279,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/issues#lock-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30507,7 +30359,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes all labels from an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-all-labels-from-an-issue", + "documentationUrl": "https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30649,7 +30501,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30732,7 +30584,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/labels#set-labels-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30833,7 +30685,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/issues#unlock-an-issue", "previews": [], "headers": [], "parameters": [ @@ -30894,7 +30746,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/issues/issues#update-an-issue", "previews": [], "headers": [], "parameters": [ @@ -31075,7 +30927,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#update-an-issue-comment", + "documentationUrl": "https://docs.github.com/rest/issues/comments#update-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -31160,7 +31012,7 @@ "deprecationDate": null, "removalDate": null, "description": "Updates a label using the given label name.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#update-a-label", + "documentationUrl": "https://docs.github.com/rest/issues/labels#update-a-label", "previews": [], "headers": [], "parameters": [ @@ -31266,7 +31118,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/issues#update-a-milestone", + "documentationUrl": "https://docs.github.com/rest/issues/milestones#update-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -31384,8 +31236,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/licenses#get-a-license", + "description": "Gets information about a specific license. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "documentationUrl": "https://docs.github.com/rest/licenses/licenses#get-a-license", "previews": [], "headers": [], "parameters": [ @@ -31428,8 +31280,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/licenses#get-all-commonly-used-licenses", + "description": "Lists the most commonly used licenses on GitHub. For more information, see \"[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository).\"", + "documentationUrl": "https://docs.github.com/rest/licenses/licenses#get-all-commonly-used-licenses", "previews": [], "headers": [], "parameters": [ @@ -31496,8 +31348,8 @@ "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", + "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/repos/contents#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/licenses/licenses#get-the-license-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -31551,7 +31403,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/markdown#render-a-markdown-document", + "documentationUrl": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document", "previews": [], "headers": [], "parameters": [ @@ -31615,7 +31467,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode", "previews": [], "headers": [ { @@ -31659,7 +31511,7 @@ "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://docs.github.com/articles/about-github-s-ip-addresses/).\"\n\nThe API's response also includes a list of GitHub's domain names.\n\nThe values shown in the documentation's response are example values. You must always query the API directly to get the latest values.\n\n**Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.", - "documentationUrl": "https://docs.github.com/rest/reference/meta#get-github-meta-information", + "documentationUrl": "https://docs.github.com/rest/meta/meta#get-apiname-meta-information", "previews": [], "headers": [], "parameters": [], @@ -31669,7 +31521,7 @@ "description": "Response", "examples": [ { - "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"SHA256_RSA\":1234567890,\"SHA256_DSA\":1234567890,\"SHA256_ECDSA\":1234567890,\"SHA256_ED25519\":1234567890},\"ssh_keys\":[\"ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\"ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\"ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ\"],\"hooks\":[\"192.0.2.1\"],\"web\":[\"192.0.2.1\"],\"api\":[\"192.0.2.1\"],\"git\":[\"192.0.2.1\"],\"packages\":[\"192.0.2.1\"],\"pages\":[\"192.0.2.1\"],\"importer\":[\"192.0.2.1\"],\"actions\":[\"192.0.2.1\"],\"dependabot\":[\"192.0.2.1\"],\"domains\":{\"website\":[\"*.example.com\"],\"codespaces\":[\"*.example.com\"],\"copilot\":[\"*.example.com\"],\"packages\":[\"*.example.com\"]}}" + "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"SHA256_RSA\":1234567890,\"SHA256_DSA\":1234567890,\"SHA256_ECDSA\":1234567890,\"SHA256_ED25519\":1234567890},\"ssh_keys\":[\"ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\"ecdsa-sha2-nistp256 ABCDEFGHIJKLMNOPQRSTUVWXYZ\",\"ssh-rsa ABCDEFGHIJKLMNOPQRSTUVWXYZ\"],\"hooks\":[\"192.0.2.1\"],\"github_enterprise_importer\":[\"192.0.2.1\"],\"web\":[\"192.0.2.1\"],\"api\":[\"192.0.2.1\"],\"git\":[\"192.0.2.1\"],\"packages\":[\"192.0.2.1\"],\"pages\":[\"192.0.2.1\"],\"importer\":[\"192.0.2.1\"],\"actions\":[\"192.0.2.1\"],\"dependabot\":[\"192.0.2.1\"],\"domains\":{\"website\":[\"*.example.com\"],\"codespaces\":[\"*.example.com\"],\"copilot\":[\"*.example.com\"],\"packages\":[\"*.example.com\"]}}" } ] }, @@ -31687,7 +31539,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get all supported GitHub API versions.", - "documentationUrl": "https://docs.github.com/rest/reference/meta#get-all-api-versions", + "documentationUrl": "https://docs.github.com/rest/meta/meta#get-all-api-versions", "previews": [], "headers": [], "parameters": [], @@ -31713,7 +31565,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get the octocat as ASCII art", - "documentationUrl": "https://docs.github.com/rest/reference/meta#get-octocat", + "documentationUrl": "https://docs.github.com/rest/meta/meta#get-octocat", "previews": [], "headers": [], "parameters": [ @@ -31754,7 +31606,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "https://docs.github.com/rest/meta#get-the-zen-of-github", + "documentationUrl": "https://docs.github.com/rest/meta/meta#get-the-zen-of-github", "previews": [], "headers": [], "parameters": [], @@ -31777,7 +31629,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/meta/meta#github-api-root", "previews": [], "headers": [], "parameters": [], @@ -33578,7 +33430,7 @@ "deprecationDate": null, "removalDate": null, "description": "Adds a team as a security manager for an organization. For more information, see \"[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization.\"\n\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope.\n\nGitHub Apps must have the `administration` organization read-write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#add-a-security-manager-team", + "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team", "previews": [], "headers": [], "parameters": [ @@ -33628,8 +33480,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#block-a-user-from-an-organization", + "description": "Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned.", + "documentationUrl": "https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization", "previews": [], "headers": [], "parameters": [ @@ -33680,7 +33532,7 @@ "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/github/managing-subscriptions-and-notifications-on-github/about-notifications).", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation", + "documentationUrl": "https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation", "previews": [], "headers": [], "parameters": [ @@ -33731,8 +33583,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization", + "description": "Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub.", + "documentationUrl": "https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization", "previews": [], "headers": [], "parameters": [ @@ -33787,7 +33639,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -33847,7 +33699,7 @@ "deprecationDate": null, "removalDate": null, "description": "Check if the provided user is a public member of the organization.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#check-public-organization-membership-for-a-user", + "documentationUrl": "https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -33902,7 +33754,7 @@ "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://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", + "documentationUrl": "https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator", "previews": [], "headers": [], "parameters": [ @@ -33972,7 +33824,7 @@ "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/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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#create-an-organization-invitation", "previews": [], "headers": [], "parameters": [ @@ -34071,7 +33923,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -34103,7 +33955,7 @@ }, { "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#create-hook-config-params).", + "description": "Key/value pairs to provide settings for this webhook.", "in": "BODY", "type": "object", "required": true, @@ -34248,7 +34100,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes an organization and all its repositories.\n\nThe organization login will be unavailable for 90 days after deletion.\n\nPlease review the Terms of Service regarding account deletion before using this endpoint:\n\nhttps://docs.github.com/site-policy/github-terms/github-terms-of-service", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs/#delete-an-organization", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#delete-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34287,7 +34139,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#delete-an-organization-webhook", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -34334,7 +34186,7 @@ "deprecationDate": null, "removalDate": null, "description": "Enables or disables the specified security feature for all eligible repositories in an organization.\n\nTo use this endpoint, you must be an organization owner or be member of a team with the security manager role.\nA token with the 'write:org' scope is also required.\n\nGitHub Apps must have the `organization_administration:write` permission to use this endpoint.\n\nFor more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#enable-or-disable-security-product-on-all-org-repos", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34384,6 +34236,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "query_suite", + "description": "CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.\nIf you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["default", "extended"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -34406,7 +34271,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#get-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34430,7 +34295,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":false,\"secret_scanning_push_protection_custom_link_enabled\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\"}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"archived_at\":null,\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" } ] }, @@ -34448,7 +34313,7 @@ "deprecationDate": null, "removalDate": null, "description": "If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -34491,7 +34356,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -34546,8 +34411,8 @@ "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", + "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -34601,8 +34466,8 @@ "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", + "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/orgs/webhooks#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/orgs/webhooks#get-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34656,7 +34521,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -34730,7 +34595,7 @@ "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/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organizations", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-organizations", "previews": [], "headers": [], "parameters": [ @@ -34785,7 +34650,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34852,7 +34717,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization", "previews": [], "headers": [], "parameters": [ @@ -34919,7 +34784,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-failed-organization-invitations", "previews": [], "headers": [], "parameters": [ @@ -34987,7 +34852,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -35047,8 +34912,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List [public organization memberships](https://docs.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", + "description": "List [public organization memberships](https://docs.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/orgs/orgs#list-organizations-for-the-authenticated-user) API instead.", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -35115,7 +34980,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-organization-invitation-teams", "previews": [], "headers": [], "parameters": [ @@ -35196,7 +35061,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-organization-members", "previews": [], "headers": [], "parameters": [ @@ -35294,7 +35159,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all of the authenticated user's organization memberships.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-organization-memberships-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -35373,7 +35238,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -35448,12 +35313,12 @@ "scope": "orgs", "id": "listPatGrantRepositories", "method": "GET", - "url": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories", + "url": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to", "previews": [], "headers": [], "parameters": [ @@ -35531,12 +35396,12 @@ "scope": "orgs", "id": "listPatGrantRequestRepositories", "method": "GET", - "url": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", + "url": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token", "previews": [], "headers": [], "parameters": [ @@ -35614,12 +35479,12 @@ "scope": "orgs", "id": "listPatGrantRequests", "method": "GET", - "url": "/organizations/{org}/personal-access-token-requests", + "url": "/orgs/{org}/personal-access-token-requests", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", "previews": [], "headers": [], "parameters": [ @@ -35760,7 +35625,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":25381,\"reason\":\"I need to access the GitHub API\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"repository_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"created_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" + "data": "[{\"id\":25381,\"reason\":\"I need to access the GitHub API\",\"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},\"repository_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-token-requests/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"created_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" } ] }, @@ -35780,12 +35645,12 @@ "scope": "orgs", "id": "listPatGrants", "method": "GET", - "url": "/organizations/{org}/personal-access-tokens", + "url": "/orgs/{org}/personal-access-tokens", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: read` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources", "previews": [], "headers": [], "parameters": [ @@ -35926,7 +35791,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":25381,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"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\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"repository_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"access_granted_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" + "data": "[{\"id\":25381,\"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},\"repository_selection\":\"all\",\"repositories_url\":\"https://api.github.com/organizations/652551/personal-access-tokens/25381/repositories\",\"permissions\":{\"organization\":{\"members\":\"read\"},\"repository\":{\"metadata\":\"read\"}},\"access_granted_at\":\"2023-05-16T08:47:09.000-07:00\",\"token_expired\":false,\"token_expires_at\":\"2023-11-16T08:47:09.000-07:00\",\"token_last_used_at\":null}]" } ] }, @@ -35951,7 +35816,7 @@ "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`, or `hiring_manager`. 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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-pending-organization-invitations", "previews": [], "headers": [], "parameters": [ @@ -36051,7 +35916,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#list-public-organization-members", "previews": [], "headers": [], "parameters": [ @@ -36118,7 +35983,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists teams that are security managers for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope.\n\nGitHub Apps must have the `administration` organization read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-security-manager-teams", + "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams", "previews": [], "headers": [], "parameters": [ @@ -36159,7 +36024,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -36259,7 +36124,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-organization-webhooks", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks", "previews": [], "headers": [], "parameters": [ @@ -36327,7 +36192,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -36374,7 +36239,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -36444,7 +36309,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#remove-an-organization-member", "previews": [], "headers": [], "parameters": [ @@ -36491,7 +36356,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -36539,7 +36404,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization", "previews": [], "headers": [], "parameters": [ @@ -36577,7 +36442,7 @@ "description": "Unprocessable Entity if user is a member of the organization", "examples": [ { - "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://docs.github.com/rest/reference/orgs#remove-outside-collaborator\"}" + "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization\"}" } ] } @@ -36594,7 +36459,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -36638,7 +36503,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes the security manager role from a team for an organization. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization.\"\n\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope.\n\nGitHub Apps must have the `administration` organization read-write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#remove-a-security-manager-team", + "documentationUrl": "https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team", "previews": [], "headers": [], "parameters": [ @@ -36677,12 +36542,12 @@ "scope": "orgs", "id": "reviewPatGrantRequest", "method": "POST", - "url": "/organizations/{org}/personal-access-token-requests/{pat_request_id}", + "url": "/orgs/{org}/personal-access-token-requests/{pat_request_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token", "previews": [], "headers": [], "parameters": [ @@ -36761,12 +36626,12 @@ "scope": "orgs", "id": "reviewPatGrantRequestsInBulk", "method": "POST", - "url": "/organizations/{org}/personal-access-token-requests", + "url": "/orgs/{org}/personal-access-token-requests", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API,\nusing the `organization_personal_access_token_requests: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens", "previews": [], "headers": [], "parameters": [ @@ -36849,8 +36714,8 @@ "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", + "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/orgs/members#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/orgs/members#set-organization-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -36923,7 +36788,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -36969,8 +36834,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#unblock-a-user-from-an-organization", + "description": "Unblocks the given user on behalf of the specified organization.", + "documentationUrl": "https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization", "previews": [], "headers": [], "parameters": [ @@ -37014,7 +36879,7 @@ "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 or the `repo` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-an-organization", + "documentationUrl": "https://docs.github.com/rest/orgs/orgs#update-an-organization", "previews": [], "headers": [], "parameters": [ @@ -37415,7 +37280,7 @@ "description": "Response", "examples": [ { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":false,\"secret_scanning_push_protection_custom_link_enabled\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\"}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\",\"archived_at\":null,\"dependency_graph_enabled_for_new_repositories\":false,\"dependabot_alerts_enabled_for_new_repositories\":false,\"dependabot_security_updates_enabled_for_new_repositories\":false,\"advanced_security_enabled_for_new_repositories\":false,\"secret_scanning_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_enabled_for_new_repositories\":false,\"secret_scanning_push_protection_custom_link\":\"https://github.com/octo-org/octo-repo/blob/main/im-blocked.md\",\"secret_scanning_push_protection_custom_link_enabled\":false}" } ] }, @@ -37434,7 +37299,7 @@ "deprecationDate": null, "removalDate": null, "description": "Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.", - "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -37490,12 +37355,12 @@ "scope": "orgs", "id": "updatePatAccess", "method": "POST", - "url": "/organizations/{org}/personal-access-tokens/{pat_id}", + "url": "/orgs/{org}/personal-access-tokens/{pat_id}", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources", "previews": [], "headers": [], "parameters": [ @@ -37561,12 +37426,12 @@ "scope": "orgs", "id": "updatePatAccesses", "method": "POST", - "url": "/organizations/{org}/personal-access-tokens", + "url": "/orgs/{org}/personal-access-tokens", "isDeprecated": false, "deprecationDate": null, "removalDate": null, "description": "Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API,\nusing the `organization_personal_access_tokens: write` permission.\n\n**Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.", - "documentationUrl": "https://docs.github.com/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", + "documentationUrl": "https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens", "previews": [], "headers": [], "parameters": [ @@ -37636,8 +37501,8 @@ "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", + "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/orgs/webhooks#update-a-webhook-configuration-for-an-organization).\"", + "documentationUrl": "https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook", "previews": [], "headers": [], "parameters": [ @@ -37669,7 +37534,7 @@ }, { "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/orgs#update-hook-config-params).", + "description": "Key/value pairs to provide settings for this webhook.", "in": "BODY", "type": "object", "required": false, @@ -37800,8 +37665,8 @@ "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", + "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/orgs/webhooks#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/orgs/webhooks#update-a-webhook-configuration-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -37907,7 +37772,7 @@ "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 `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -37960,7 +37825,7 @@ "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 `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -38026,7 +37891,7 @@ "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 `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -38092,7 +37957,7 @@ "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 `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -38158,7 +38023,7 @@ "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 `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -38237,7 +38102,7 @@ "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 `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -38316,7 +38181,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization", "previews": [], "headers": [], "parameters": [ @@ -38440,7 +38305,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -38551,7 +38416,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -38651,7 +38516,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization", "previews": [], "headers": [], "parameters": [ @@ -38764,7 +38629,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists 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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user", "previews": [], "headers": [], "parameters": [ @@ -38838,7 +38703,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -38892,7 +38757,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -38959,7 +38824,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -39026,7 +38891,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -39093,7 +38958,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -39173,7 +39038,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -39253,7 +39118,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", - "documentationUrl": "https://docs.github.com/rest/packages#list-docker-migration-conflicting-packages-for-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-authenticated-user", "previews": [], "headers": [], "parameters": [], @@ -39280,7 +39145,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization", "previews": [], "headers": [], "parameters": [ @@ -39327,7 +39192,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration.\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/packages#list-docker-migration-conflicting-packages-for-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user", "previews": [], "headers": [], "parameters": [ @@ -39374,7 +39239,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-the-authenticated-users-namespace", "previews": [], "headers": [], "parameters": [ @@ -39459,7 +39324,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -39563,7 +39428,7 @@ "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 `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#list-packages-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -39667,7 +39532,7 @@ "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 `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -39733,7 +39598,7 @@ "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 `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -39812,7 +39677,7 @@ "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 `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -39891,7 +39756,7 @@ "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 `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -39957,7 +39822,7 @@ "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 `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -40036,7 +39901,7 @@ "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 `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"", - "documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user", + "documentationUrl": "https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -40115,7 +39980,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/collaborators#add-project-collaborator", "previews": [], "headers": [], "parameters": [ @@ -40187,7 +40052,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-project-card", + "documentationUrl": "https://docs.github.com/rest/projects/cards#create-a-project-card", "previews": [], "headers": [], "parameters": [ @@ -40276,7 +40141,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a new project column.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#create-a-project-column", + "documentationUrl": "https://docs.github.com/rest/projects/columns#create-a-project-column", "previews": [], "headers": [], "parameters": [ @@ -40342,7 +40207,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. 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-user-project", + "documentationUrl": "https://docs.github.com/rest/projects/projects#create-a-user-project", "previews": [], "headers": [], "parameters": [ @@ -40408,7 +40273,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. 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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#create-an-organization-project", "previews": [], "headers": [], "parameters": [ @@ -40488,7 +40353,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. 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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#create-a-repository-project", "previews": [], "headers": [], "parameters": [ @@ -40581,7 +40446,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#delete-a-project", "previews": [], "headers": [], "parameters": [ @@ -40623,7 +40488,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a project card", - "documentationUrl": "https://docs.github.com/rest/reference/projects#delete-a-project-card", + "documentationUrl": "https://docs.github.com/rest/projects/cards#delete-a-project-card", "previews": [], "headers": [], "parameters": [ @@ -40664,7 +40529,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a project column.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#delete-a-project-column", + "documentationUrl": "https://docs.github.com/rest/projects/columns#delete-a-project-column", "previews": [], "headers": [], "parameters": [ @@ -40704,7 +40569,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#get-a-project", "previews": [], "headers": [], "parameters": [ @@ -40752,7 +40617,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a project card.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#get-a-project-card", + "documentationUrl": "https://docs.github.com/rest/projects/cards#get-a-project-card", "previews": [], "headers": [], "parameters": [ @@ -40801,7 +40666,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a project column.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#get-a-project-column", + "documentationUrl": "https://docs.github.com/rest/projects/columns#get-a-project-column", "previews": [], "headers": [], "parameters": [ @@ -40850,7 +40715,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -40917,7 +40782,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the project cards in a project.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#list-project-cards", + "documentationUrl": "https://docs.github.com/rest/projects/cards#list-project-cards", "previews": [], "headers": [], "parameters": [ @@ -41004,7 +40869,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/collaborators#list-project-collaborators", "previews": [], "headers": [], "parameters": [ @@ -41097,7 +40962,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the project columns in a project.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#list-project-columns", + "documentationUrl": "https://docs.github.com/rest/projects/columns#list-project-columns", "previews": [], "headers": [], "parameters": [ @@ -41171,7 +41036,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#list-organization-projects", "previews": [], "headers": [], "parameters": [ @@ -41256,7 +41121,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#list-repository-projects", "previews": [], "headers": [], "parameters": [ @@ -41362,7 +41227,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists projects for a user.", - "documentationUrl": "https://docs.github.com/rest/reference/projects#list-user-projects", + "documentationUrl": "https://docs.github.com/rest/projects/projects#list-user-projects", "previews": [], "headers": [], "parameters": [ @@ -41447,7 +41312,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/projects#move-a-project-card", + "documentationUrl": "https://docs.github.com/rest/projects/cards#move-a-project-card", "previews": [], "headers": [], "parameters": [ @@ -41523,7 +41388,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/projects#move-a-project-column", + "documentationUrl": "https://docs.github.com/rest/projects/columns#move-a-project-column", "previews": [], "headers": [], "parameters": [ @@ -41585,7 +41450,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator", "previews": [], "headers": [], "parameters": [ @@ -41644,7 +41509,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/projects/projects#update-a-project", "previews": [], "headers": [], "parameters": [ @@ -41768,7 +41633,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/projects#update-a-project-card", + "documentationUrl": "https://docs.github.com/rest/projects/cards#update-an-existing-project-card", "previews": [], "headers": [], "parameters": [ @@ -41848,7 +41713,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/projects#update-a-project-column", + "documentationUrl": "https://docs.github.com/rest/projects/columns#update-an-existing-project-column", "previews": [], "headers": [], "parameters": [ @@ -41909,7 +41774,7 @@ "deprecationDate": null, "removalDate": null, "description": "Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#check-if-a-pull-request-has-been-merged", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged", "previews": [], "headers": [], "parameters": [ @@ -41977,7 +41842,7 @@ "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://docs.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\nThis 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-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#create-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42141,7 +42006,7 @@ "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/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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment", "previews": [], "headers": [], "parameters": [ @@ -42234,8 +42099,8 @@ "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.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request).\"\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 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", + "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.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request).\"\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 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/pulls/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/pulls/reviews#create-a-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42306,7 +42171,7 @@ }, { "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready.", "in": "BODY", "type": "string", "required": false, @@ -42450,8 +42315,8 @@ "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\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\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/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", + "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/issues/comments#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\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\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/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/pulls/comments#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42617,7 +42482,7 @@ "in": "BODY", "type": "string", "required": false, - "enum": ["LINE", "FILE"], + "enum": ["line", "file"], "allowNull": false, "mapToData": null, "validation": null, @@ -42654,7 +42519,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#delete-a-pending-review-for-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42740,7 +42605,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42799,8 +42664,8 @@ "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", + "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), 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/pulls/reviews#dismiss-a-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42911,8 +42776,8 @@ "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://docs.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://docs.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://docs.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://docs.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", + "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://docs.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/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/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://docs.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://docs.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://docs.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/pulls/pulls#get-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -42983,7 +42848,7 @@ "deprecationDate": null, "removalDate": null, "description": "Retrieves a pull request review by its ID.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-a-review-for-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43064,7 +42929,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43132,7 +42997,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-pull-requests", "previews": [], "headers": [], "parameters": [ @@ -43283,7 +43148,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review", "previews": [], "headers": [], "parameters": [ @@ -43389,8 +43254,8 @@ "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", + "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/commits/commits#list-commits) endpoint.", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43483,7 +43348,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#list-pull-requests-files", "previews": [], "headers": [], "parameters": [ @@ -43583,7 +43448,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43650,7 +43515,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43721,7 +43586,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -43782,7 +43647,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository", "previews": [], "headers": [], "parameters": [ @@ -43840,7 +43705,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -43901,7 +43766,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -43994,7 +43859,7 @@ "deprecationDate": null, "removalDate": null, "description": "Merges a pull request into the base branch.\nThis 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", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#merge-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44136,7 +44001,7 @@ "deprecationDate": null, "removalDate": null, "description": "Removes review requests from a pull request for a given set of users and/or teams.", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request", + "documentationUrl": "https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44332,8 +44197,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request).\"", - "documentationUrl": "https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request", + "description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request).\"", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44446,7 +44311,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44584,7 +44449,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch", "previews": [], "headers": [], "parameters": [ @@ -44629,7 +44494,7 @@ }, { "name": "expected_head_sha", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/rest/commits/commits#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", "in": "BODY", "type": "string", "required": false, @@ -44670,7 +44535,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44768,7 +44633,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request", "previews": [], "headers": [], "parameters": [ @@ -44847,8 +44712,8 @@ "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", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/overview/api-versions).\"\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/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [], @@ -44858,7 +44723,7 @@ "description": "Response", "examples": [ { - "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452,\"used\":12},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389,\"used\":7},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725,\"used\":1},\"code_scanning_upload\":{\"limit\":500,\"remaining\":499,\"reset\":1551806725,\"used\":1}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1}}" + "data": "{\"resources\":{\"core\":{\"limit\":5000,\"used\":1,\"remaining\":4999,\"reset\":1691591363},\"search\":{\"limit\":30,\"used\":12,\"remaining\":18,\"reset\":1691591091},\"graphql\":{\"limit\":5000,\"used\":7,\"remaining\":4993,\"reset\":1691593228},\"integration_manifest\":{\"limit\":5000,\"used\":1,\"remaining\":4999,\"reset\":1691594631},\"source_import\":{\"limit\":100,\"used\":1,\"remaining\":99,\"reset\":1691591091},\"code_scanning_upload\":{\"limit\":500,\"used\":1,\"remaining\":499,\"reset\":1691594631},\"actions_runner_registration\":{\"limit\":10000,\"used\":0,\"remaining\":10000,\"reset\":1691594631},\"scim\":{\"limit\":15000,\"used\":0,\"remaining\":15000,\"reset\":1691594631},\"dependency_snapshots\":{\"limit\":100,\"used\":0,\"remaining\":100,\"reset\":1691591091},\"code_search\":{\"limit\":10,\"used\":0,\"remaining\":10,\"reset\":1691591091}},\"rate\":{\"limit\":5000,\"used\":1,\"remaining\":4999,\"reset\":1372700873}}" } ] }, @@ -44876,8 +44741,8 @@ "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", + "description": "Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). 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/reactions/reactions#create-reaction-for-a-commit-comment", "previews": [], "headers": [], "parameters": [ @@ -44922,7 +44787,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the commit comment.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.", "in": "BODY", "type": "string", "required": true, @@ -44979,8 +44844,8 @@ "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", + "description": "Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue.", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -45025,7 +44890,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.", "in": "BODY", "type": "string", "required": true, @@ -45082,8 +44947,8 @@ "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", + "description": "Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). 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/reactions/reactions#create-reaction-for-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -45128,7 +44993,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the issue comment.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.", "in": "BODY", "type": "string", "required": true, @@ -45185,8 +45050,8 @@ "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", + "description": "Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). 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/reactions/reactions#create-reaction-for-a-pull-request-review-comment", "previews": [], "headers": [], "parameters": [ @@ -45231,7 +45096,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the pull request review comment.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment.", "in": "BODY", "type": "string", "required": true, @@ -45288,8 +45153,8 @@ "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", + "description": "Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release", "previews": [], "headers": [], "parameters": [ @@ -45334,7 +45199,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release.", "in": "BODY", "type": "string", "required": true, @@ -45382,8 +45247,8 @@ "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", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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/reactions/reactions#create-reaction-for-a-team-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -45441,7 +45306,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "in": "BODY", "type": "string", "required": true, @@ -45493,8 +45358,8 @@ "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", + "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/reactions/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -45539,7 +45404,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.", "in": "BODY", "type": "string", "required": true, @@ -45582,8 +45447,8 @@ "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", + "description": "Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). 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/reactions/reactions#create-reaction-for-a-team-discussion", "previews": [], "headers": [], "parameters": [ @@ -45628,7 +45493,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", "in": "BODY", "type": "string", "required": true, @@ -45680,8 +45545,8 @@ "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", + "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/reactions/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). 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/reactions/reactions#create-reaction-for-a-team-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -45713,7 +45578,7 @@ }, { "name": "content", - "description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the team discussion.", + "description": "The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.", "in": "BODY", "type": "string", "required": true, @@ -45756,8 +45621,8 @@ "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", + "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/commits/comments#get-a-commit-comment).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction", "previews": [], "headers": [], "parameters": [ @@ -45826,8 +45691,8 @@ "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", + "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/issues/issues#get-an-issue).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction", "previews": [], "headers": [], "parameters": [ @@ -45896,8 +45761,8 @@ "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", + "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/issues/comments#get-an-issue-comment).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction", "previews": [], "headers": [], "parameters": [ @@ -45966,8 +45831,8 @@ "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", + "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/pulls/comments#get-a-review-comment-for-a-pull-request).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction", "previews": [], "headers": [], "parameters": [ @@ -46036,8 +45901,8 @@ "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/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions/#delete-a-release-reaction", + "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction", "previews": [], "headers": [], "parameters": [ @@ -46106,8 +45971,8 @@ "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", + "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/teams/discussions#get-a-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/reactions/reactions#delete-team-discussion-reaction", "previews": [], "headers": [], "parameters": [ @@ -46176,8 +46041,8 @@ "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", + "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/teams/discussion-comments#get-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/reactions/reactions#delete-team-discussion-comment-reaction", "previews": [], "headers": [], "parameters": [ @@ -46259,8 +46124,8 @@ "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", + "description": "List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment", "previews": [], "headers": [], "parameters": [ @@ -46305,7 +46170,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment.", "in": "QUERY", "type": "string", "required": false, @@ -46375,8 +46240,8 @@ "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", + "description": "List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -46421,7 +46286,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue.", "in": "QUERY", "type": "string", "required": false, @@ -46492,8 +46357,8 @@ "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", + "description": "List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment", "previews": [], "headers": [], "parameters": [ @@ -46538,7 +46403,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment.", "in": "QUERY", "type": "string", "required": false, @@ -46608,8 +46473,8 @@ "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", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment", "previews": [], "headers": [], "parameters": [ @@ -46654,7 +46519,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment.", "in": "QUERY", "type": "string", "required": false, @@ -46724,8 +46589,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/rest/reference/reactions/#list-reactions-for-a-release", + "description": "List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release).", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release", "previews": [], "headers": [], "parameters": [ @@ -46770,7 +46635,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release.", "in": "QUERY", "type": "string", "required": false, @@ -46831,8 +46696,8 @@ "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", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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/reactions/reactions#list-reactions-for-a-team-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -46890,7 +46755,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "QUERY", "type": "string", "required": false, @@ -46959,8 +46824,8 @@ "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", + "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/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -47005,7 +46870,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment.", "in": "QUERY", "type": "string", "required": false, @@ -47074,8 +46939,8 @@ "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", + "description": "List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions`.", + "documentationUrl": "https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion", "previews": [], "headers": [], "parameters": [ @@ -47120,7 +46985,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "QUERY", "type": "string", "required": false, @@ -47189,8 +47054,8 @@ "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", + "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/reactions/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-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/reactions/reactions#list-reactions-for-a-team-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -47222,7 +47087,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "description": "Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion.", "in": "QUERY", "type": "string", "required": false, @@ -47458,99 +47323,186 @@ "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.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\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**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\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.", + "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.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\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 [API](https://docs.github.com/rest/collaborators/invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\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/collaborators/collaborators#add-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when a new invitation is created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"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},\"inviter\":{\"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},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - }, - { - "code": 204, - "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add status check contexts", - "scope": "repos", - "id": "addStatusCheckContexts", - "method": "POST", - "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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "permission", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "Response when a new invitation is created", + "examples": [ + { + "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"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}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"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},\"inviter\":{\"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},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" + } + ] + }, + { + "code": 204, + "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator", + "examples": null + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Add status check contexts", + "scope": "repos", + "id": "addStatusCheckContexts", + "method": "POST", + "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://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "contexts", + "description": "", + "in": "BODY", + "type": null, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": true, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Add team access restrictions", + "scope": "repos", + "id": "addTeamAccessRestrictions", + "method": "POST", + "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://docs.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.", + "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47594,7 +47546,7 @@ "deprecated": null }, { - "name": "contexts", + "name": "teams", "description": "", "in": "BODY", "type": null, @@ -47613,12 +47565,10 @@ "description": "Response", "examples": [ { - "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -47628,16 +47578,16 @@ "renamed": null }, { - "name": "Add team access restrictions", + "name": "Add user access restrictions", "scope": "repos", - "id": "addTeamAccessRestrictions", + "id": "addUserAccessRestrictions", "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "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://docs.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.", - "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions", + "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://docs.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/branches/branch-protection#add-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47681,7 +47631,7 @@ "deprecated": null }, { - "name": "teams", + "name": "users", "description": "", "in": "BODY", "type": null, @@ -47700,7 +47650,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "[{\"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}]" } ] }, @@ -47713,16 +47663,16 @@ "renamed": null }, { - "name": "Add user access restrictions", + "name": "Check if automated security fixes are enabled for a repository", "scope": "repos", - "id": "addUserAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "id": "checkAutomatedSecurityFixes", + "method": "GET", + "url": "/repos/{owner}/{repo}/automated-security-fixes", "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://docs.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/branches/branch-protection#add-user-access-restrictions", + "description": "Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".", + "documentationUrl": "https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -47751,47 +47701,17 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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}]" - } - ] + "description": "Response if dependabot is enabled", + "examples": [{ "data": "{\"enabled\":true,\"paused\":false}" }] }, { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", + "code": 404, + "description": "Not Found if dependabot is not enabled for the repository", "examples": null } ], @@ -47875,7 +47795,7 @@ "deprecationDate": null, "removalDate": null, "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", - "documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -47930,7 +47850,7 @@ "deprecationDate": null, "removalDate": null, "description": "List any syntax errors that are detected in the CODEOWNERS\nfile.\n\nFor more information about the correct CODEOWNERS syntax,\nsee \"[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners).\"", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-codeowners-errors", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-codeowners-errors", "previews": [], "headers": [], "parameters": [ @@ -48612,7 +48532,7 @@ "deprecationDate": null, "removalDate": null, "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/rest/deploy-keys#create-a-deploy-key", + "documentationUrl": "https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -48709,7 +48629,7 @@ "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/commits/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`.", + "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/commits/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\nMerged branch response:\n\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\nMerge conflict response:\n\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\nFailed commit status checks:\n\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/deployments/deployments#create-a-deployment", "previews": [], "headers": [], @@ -48900,7 +48820,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy", + "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy", "previews": [], "headers": [], "parameters": [ @@ -48993,7 +48913,7 @@ "deprecationDate": null, "removalDate": null, "description": "Enable a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).", - "documentationUrl": "https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule", + "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment", "previews": [], "headers": [], "parameters": [ @@ -49072,7 +48992,7 @@ "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.", + "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/deployments/statuses#create-a-deployment-status", "previews": [], "headers": [], @@ -49178,11 +49098,11 @@ }, { "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used.", "in": "BODY", "type": "string", "required": false, - "enum": ["production", "staging", "qa"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -49244,7 +49164,7 @@ "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://docs.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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], "parameters": [ @@ -49334,7 +49254,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -49676,7 +49596,7 @@ "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).\n\n**Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-fork", + "documentationUrl": "https://docs.github.com/rest/repos/forks#create-a-fork", "previews": [], "headers": [], "parameters": [ @@ -49778,7 +49698,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#create-an-organization-repository", "previews": [], "headers": [], "parameters": [ @@ -50136,7 +50056,7 @@ "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:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\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. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "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:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[GitHub Actions secrets](/rest/actions/secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "documentationUrl": "https://docs.github.com/rest/deployments/environments#create-or-update-an-environment", "previews": [], "headers": [], @@ -50299,8 +50219,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-file-contents", + "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "documentationUrl": "https://docs.github.com/rest/repos/contents#create-or-update-file-contents", "previews": [], "headers": [], "parameters": [ @@ -50539,7 +50459,7 @@ "deprecationDate": null, "removalDate": null, "description": "Create a repository ruleset for an organization.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#create-organization-repository-ruleset", + "documentationUrl": "https://docs.github.com/rest/orgs/rules#create-an-organization-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -50613,7 +50533,7 @@ "description": "The ID of the actor that can bypass a ruleset", "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -50626,8 +50546,21 @@ "description": "The type of actor that can bypass a ruleset", "in": "BODY", "type": "string", - "required": false, - "enum": ["Team", "Integration"], + "required": true, + "enum": ["RepositoryRole", "Team", "Integration", "OrganizationAdmin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_actors[].bypass_mode", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["always", "pull_request"], "allowNull": false, "mapToData": null, "validation": null, @@ -50636,7 +50569,7 @@ }, { "name": "conditions", - "description": "Conditions for a organization ruleset", + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", "in": "BODY", "type": "object", "required": false, @@ -50888,7 +50821,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" + "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" } ] }, @@ -50907,7 +50840,7 @@ "deprecationDate": null, "removalDate": null, "description": "Create a GitHub Pages deployment for a repository.\n\nUsers must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/pages#create-a-github-pages-deployment", + "documentationUrl": "https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment", "previews": [], "headers": [], "parameters": [ @@ -51021,7 +50954,7 @@ "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).\"\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", - "documentationUrl": "https://docs.github.com/rest/pages#create-a-github-pages-site", + "documentationUrl": "https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site", "previews": [], "headers": [], "parameters": [ @@ -51314,7 +51247,7 @@ "deprecationDate": null, "removalDate": null, "description": "Create a ruleset for a repository.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#create-repository-ruleset", + "documentationUrl": "https://docs.github.com/rest/repos/rules#create-a-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -51383,19 +51316,6 @@ "alias": null, "deprecated": null }, - { - "name": "bypass_mode", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["none", "repository", "organization"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "bypass_actors", "description": "The actors that can bypass the rules in this ruleset", @@ -51414,7 +51334,7 @@ "description": "The ID of the actor that can bypass a ruleset", "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -51427,8 +51347,21 @@ "description": "The type of actor that can bypass a ruleset", "in": "BODY", "type": "string", - "required": false, - "enum": ["Team", "Integration"], + "required": true, + "enum": ["RepositoryRole", "Team", "Integration", "OrganizationAdmin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_actors[].bypass_mode", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["always", "pull_request"], "allowNull": false, "mapToData": null, "validation": null, @@ -51728,7 +51661,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" + "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" } ] }, @@ -51747,7 +51680,7 @@ "deprecationDate": null, "removalDate": null, "description": "This creates a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#create-tag-protection-state-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -51811,14 +51744,14 @@ "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. If the repository is not public, 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", + "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. If the repository is not public, 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/repos/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/repos/repos#create-a-repository-using-a-template", "previews": [], "headers": [], "parameters": [ { "name": "template_owner", - "description": "", + "description": "The account owner of the template repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51831,7 +51764,7 @@ }, { "name": "template_repo", - "description": "", + "description": "The name of the template repository without the `.git` extension. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -51976,7 +51909,7 @@ }, { "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", + "description": "Key/value pairs to provide settings for this webhook.", "in": "BODY", "type": "object", "required": false, @@ -52204,7 +52137,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#delete-a-repository", "previews": [], "headers": [], "parameters": [ @@ -52243,7 +52176,7 @@ "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", "examples": [ { - "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://docs.github.com/rest/reference/repos#delete-a-repository\"}" + "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://docs.github.com/rest/repos/repos#delete-a-repository\"}" } ] }, @@ -52677,7 +52610,7 @@ "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/deploy-keys#delete-a-deploy-key", + "documentationUrl": "https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -52733,7 +52666,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a 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/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status).\"", + "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a 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/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status).\"", "documentationUrl": "https://docs.github.com/rest/deployments/deployments#delete-a-deployment", "previews": [], "headers": [], @@ -52799,7 +52732,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy", + "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy", "previews": [], "headers": [], "parameters": [ @@ -52868,8 +52801,8 @@ "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.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-file", + "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.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", + "documentationUrl": "https://docs.github.com/rest/repos/contents#delete-a-file", "previews": [], "headers": [], "parameters": [ @@ -53118,7 +53051,7 @@ "deprecationDate": null, "removalDate": null, "description": "Delete a ruleset for an organization.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#delete-organization-ruleset", + "documentationUrl": "https://docs.github.com/rest/orgs/rules#delete-an-organization-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -53166,7 +53099,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", - "documentationUrl": "https://docs.github.com/rest/pages#delete-a-github-pages-site", + "documentationUrl": "https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site", "previews": [], "headers": [], "parameters": [ @@ -53279,7 +53212,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/releases#delete-a-release", "previews": [], "headers": [], "parameters": [ @@ -53336,7 +53269,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-release-asset", + "documentationUrl": "https://docs.github.com/rest/releases/assets#delete-a-release-asset", "previews": [], "headers": [], "parameters": [ @@ -53393,7 +53326,7 @@ "deprecationDate": null, "removalDate": null, "description": "Delete a ruleset for a repository.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#delete-repository-ruleset", + "documentationUrl": "https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -53454,7 +53387,7 @@ "deprecationDate": null, "removalDate": null, "description": "This deletes a tag protection state for a repository.\nThis endpoint is only available to repository administrators.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-tag-protection-state-for-a-repository", + "documentationUrl": "https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -53575,7 +53508,7 @@ "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://docs.github.com/articles/configuring-automated-security-fixes)\".", - "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-automated-security-fixes", + "documentationUrl": "https://docs.github.com/rest/repos/repos#disable-automated-security-fixes", "previews": [], "headers": [], "parameters": [ @@ -53619,7 +53552,7 @@ "deprecationDate": null, "removalDate": null, "description": "Disables a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)\".", - "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule", + "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment", "previews": [], "headers": [], "parameters": [ @@ -53680,16 +53613,16 @@ "renamed": null }, { - "name": "Disable Git LFS for a repository", + "name": "Disable private vulnerability reporting for a repository", "scope": "repos", - "id": "disableLfsForRepo", + "id": "disablePrivateVulnerabilityReporting", "method": "DELETE", - "url": "/repos/{owner}/{repo}/lfs", + "url": "/repos/{owner}/{repo}/private-vulnerability-reporting", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository", + "description": "Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\".", + "documentationUrl": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -53720,7 +53653,15 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 204, + "description": "A header with no content is returned.", + "examples": null + }, + { "code": 422, "description": "Bad Request", "examples": null }, + { "code": 422, "description": "Bad Request", "examples": null } + ], "renamed": null }, { @@ -53733,7 +53674,7 @@ "deprecationDate": null, "removalDate": null, "description": "Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", - "documentationUrl": "https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts", + "documentationUrl": "https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts", "previews": [], "headers": [], "parameters": [ @@ -53777,7 +53718,7 @@ "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`main`) 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", + "documentationUrl": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar", "previews": [], "headers": [], "parameters": [ @@ -53839,7 +53780,7 @@ "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`main`) 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\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", + "documentationUrl": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip", "previews": [], "headers": [], "parameters": [ @@ -53901,7 +53842,7 @@ "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`main`) 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", + "documentationUrl": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar", "previews": [], "headers": [], "parameters": [ @@ -53958,7 +53899,7 @@ "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`main`) 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\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive", + "documentationUrl": "https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip", "previews": [], "headers": [], "parameters": [ @@ -54015,7 +53956,7 @@ "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://docs.github.com/articles/configuring-automated-security-fixes)\".", - "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-automated-security-fixes", + "documentationUrl": "https://docs.github.com/rest/repos/repos#enable-automated-security-fixes", "previews": [], "headers": [], "parameters": [ @@ -54050,16 +53991,16 @@ "renamed": null }, { - "name": "Enable Git LFS for a repository", + "name": "Enable private vulnerability reporting for a repository", "scope": "repos", - "id": "enableLfsForRepo", + "id": "enablePrivateVulnerabilityReporting", "method": "PUT", - "url": "/repos/{owner}/{repo}/lfs", + "url": "/repos/{owner}/{repo}/private-vulnerability-reporting", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository", + "description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"", + "documentationUrl": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -54092,15 +54033,12 @@ ], "responses": [ { - "code": 202, - "description": "Accepted", - "examples": [{ "data": "null" }] - }, - { - "code": 403, - "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .", + "code": 204, + "description": "A header with no content is returned.", "examples": null - } + }, + { "code": 422, "description": "Bad Request", "examples": null }, + { "code": 422, "description": "Bad Request", "examples": null } ], "renamed": null }, @@ -54114,7 +54052,7 @@ "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://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".", - "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts", + "documentationUrl": "https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts", "previews": [], "headers": [], "parameters": [ @@ -54157,8 +54095,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#generate-release-notes", + "description": "Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", + "documentationUrl": "https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release", "previews": [], "headers": [], "parameters": [ @@ -54265,7 +54203,7 @@ "deprecationDate": null, "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.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", - "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository", + "documentationUrl": "https://docs.github.com/rest/repos/repos#get-a-repository", "previews": [], "headers": [], "parameters": [ @@ -54421,8 +54359,75 @@ "deprecated": null }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get all deployment protection rules for an environment", + "scope": "repos", + "id": "getAllDeploymentProtectionRules", + "method": "GET", + "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).", + "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "environment_name", + "description": "The name of the environment.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -54437,79 +54442,16 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "List of deployment protection rules", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" + "data": "{\"total_count\":2,\"custom_deployment_protection_rules\":[{\"id\":3,\"node_id\":\"IEH37kRlcGxveW1lbnRTdGF0ddiv\",\"enabled\":true,\"app\":{\"id\":1,\"node_id\":\"GHT58kRlcGxveW1lbnRTdTY!bbcy\",\"slug\":\"a-custom-app\",\"integration_url\":\"https://api.github.com/apps/a-custom-app\"}},{\"id\":4,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdHJ41128\",\"enabled\":true,\"app\":{\"id\":1,\"node_id\":\"UHVE67RlcGxveW1lbnRTdTY!jfeuy\",\"slug\":\"another-custom-app\",\"integration_url\":\"https://api.github.com/apps/another-custom-app\"}}]}" } ] } ], "renamed": null }, - { - "name": "Get all deployment protection rules for an environment", - "scope": "repos", - "id": "getAllDeploymentProtectionRules", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", - "isDeprecated": false, - "deprecationDate": null, - "removalDate": null, - "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).", - "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "List of deployment protection rules", - "examples": null - } - ], - "renamed": null - }, { "name": "List environments", "scope": "repos", @@ -54664,7 +54606,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-repository-topics", + "documentationUrl": "https://docs.github.com/rest/repos/repos#get-all-repository-topics", "previews": [], "headers": [], "parameters": [ @@ -54743,7 +54685,7 @@ "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://docs.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/branches/branch-protection#list-apps-with-access-to-the-protected-branch", + "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -55015,7 +54957,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Returns all rules that apply to the specified branch.", + "description": "Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply\nto a branch with that name will be returned. All active rules that apply will be returned, regardless of the level\nat which they are configured (e.g. repository or organization). Rules in rulesets with \"evaluate\" or \"disabled\"\nenforcement statuses are not returned.", "documentationUrl": "https://docs.github.com/rest/repos/rules#get-rules-for-a-branch", "previews": [], "headers": [], @@ -55092,7 +55034,7 @@ "description": "Response", "examples": [ { - "data": "[{\"type\":\"commit_message_pattern\",\"parameters\":{\"operator\":\"starts_with\",\"pattern\":\"issue\"}},{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}]" + "data": "[{\"type\":\"commit_message_pattern\",\"ruleset_source_type\":\"Repository\",\"ruleset_source\":\"monalisa/my-repo\",\"ruleset_id\":42,\"parameters\":{\"operator\":\"starts_with\",\"pattern\":\"issue\"}},{\"type\":\"commit_author_email_pattern\",\"ruleset_source_type\":\"Organization\",\"ruleset_source\":\"my-org\",\"ruleset_id\":73,\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}]" } ] } @@ -55236,7 +55178,7 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", + "description": "Checks the repository permission of a collaborator. The possible repository\npermissions are `admin`, `write`, `read`, and `none`.\n\n*Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the\n`maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the\ncollaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The\n`permissions` hash can also be used to determine which base level of access the collaborator has to the repository.", "documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user", "previews": [], "headers": [], @@ -55337,7 +55279,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -55457,7 +55399,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -55753,8 +55695,8 @@ "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**Notes**:\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 * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n#### Size limits\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\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", + "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/overview/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/overview/media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree).\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/git/trees#get-a-tree).\n * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\n Size limits:\nIf the requested file's size is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `\"none\"`. To get the contents of these larger files, use the `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\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/repos/contents#get-repository-content", "previews": [], "headers": [], "parameters": [ @@ -55922,7 +55864,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).", - "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule", + "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule", "previews": [], "headers": [], "parameters": [ @@ -56002,7 +55944,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/deploy-keys#get-a-deploy-key", + "documentationUrl": "https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -56138,7 +56080,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy", + "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy", "previews": [], "headers": [], "parameters": [ @@ -56366,7 +56308,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about the single most recent build of a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", - "documentationUrl": "https://docs.github.com/rest/pages#get-latest-pages-build", + "documentationUrl": "https://docs.github.com/rest/pages/pages#get-latest-pages-build", "previews": [], "headers": [], "parameters": [ @@ -56420,7 +56362,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/releases#get-the-latest-release", "previews": [], "headers": [], "parameters": [ @@ -56474,7 +56416,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get a repository ruleset for an organization.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#get-organization-ruleset", + "documentationUrl": "https://docs.github.com/rest/orgs/rules#get-an-organization-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -56511,7 +56453,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" + "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" } ] }, @@ -56530,7 +56472,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get all the repository rulesets for an organization.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#get-organization-rulesets", + "documentationUrl": "https://docs.github.com/rest/orgs/rules#get-all-organization-repository-rulesets", "previews": [], "headers": [], "parameters": [ @@ -56580,7 +56522,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":21,\"name\":\"super cool ruleset\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"enabled\",\"bypass_mode\":\"repository\",\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"},{\"id\":432,\"name\":\"Another ruleset\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"enabled\",\"bypass_mode\":\"repository\",\"node_id\":\"RRS_lACkVXNlcgQQ\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/432\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/432\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}]" + "data": "[{\"id\":21,\"name\":\"super cool ruleset\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"enabled\",\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"},{\"id\":432,\"name\":\"Another ruleset\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"enabled\",\"node_id\":\"RRS_lACkVXNlcgQQ\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/432\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/432\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}]" } ] }, @@ -56599,7 +56541,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", - "documentationUrl": "https://docs.github.com/rest/pages#get-a-github-pages-site", + "documentationUrl": "https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site", "previews": [], "headers": [], "parameters": [ @@ -56654,7 +56596,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets information about a GitHub Pages build.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", - "documentationUrl": "https://docs.github.com/rest/pages#get-github-pages-build", + "documentationUrl": "https://docs.github.com/rest/pages/pages#get-apiname-pages-build", "previews": [], "headers": [], "parameters": [ @@ -56721,7 +56663,7 @@ "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\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.", - "documentationUrl": "https://docs.github.com/rest/pages#get-a-dns-health-check-for-github-pages", + "documentationUrl": "https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages", "previews": [], "headers": [], "parameters": [ @@ -56967,8 +56909,8 @@ "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", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML.", + "documentationUrl": "https://docs.github.com/rest/repos/contents#get-a-repository-readme", "previews": [], "headers": [], "parameters": [ @@ -57040,8 +56982,8 @@ "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", + "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML.", + "documentationUrl": "https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory", "previews": [], "headers": [], "parameters": [ @@ -57127,7 +57069,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release", "previews": [], "headers": [], "parameters": [ @@ -57181,7 +57123,7 @@ } ] }, - { "code": 404, "description": "Resource not found", "examples": null } + { "code": 401, "description": "Unauthorized", "examples": null } ], "renamed": null }, @@ -57195,7 +57137,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/assets#get-a-release-asset", "previews": [], "headers": [], "parameters": [ @@ -57264,7 +57206,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name", "previews": [], "headers": [], "parameters": [ @@ -57332,7 +57274,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get a ruleset for a repository.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#get-repository-ruleset", + "documentationUrl": "https://docs.github.com/rest/repos/rules#get-a-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -57395,7 +57337,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" + "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" } ] }, @@ -57414,7 +57356,7 @@ "deprecationDate": null, "removalDate": null, "description": "Get all the rulesets for a repository.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#get-repository-rulesets", + "documentationUrl": "https://docs.github.com/rest/repos/rules#get-all-repository-rulesets", "previews": [], "headers": [], "parameters": [ @@ -57490,7 +57432,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":42,\"name\":\"super cool ruleset\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"enabled\",\"bypass_mode\":\"repository\",\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"},{\"id\":314,\"name\":\"Another ruleset\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"enabled\",\"bypass_mode\":\"repository\",\"node_id\":\"RRS_lACkVXNlcgQQ\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/314\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/314\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}]" + "data": "[{\"id\":42,\"name\":\"super cool ruleset\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"enabled\",\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"},{\"id\":314,\"name\":\"Another ruleset\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"enabled\",\"node_id\":\"RRS_lACkVXNlcgQQ\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/314\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/314\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}]" } ] }, @@ -57577,7 +57519,7 @@ "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://docs.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/branches/branch-protection#list-teams-with-access-to-the-protected-branch", + "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -57737,25 +57679,229 @@ "description": "Response", "examples": [ { - "data": "[{\"referrer\":\"Google\",\"count\":4,\"uniques\":3},{\"referrer\":\"stackoverflow.com\",\"count\":2,\"uniques\":2},{\"referrer\":\"eggsonbread.com\",\"count\":1,\"uniques\":1},{\"referrer\":\"yandex.ru\",\"count\":1,\"uniques\":1}]" + "data": "[{\"referrer\":\"Google\",\"count\":4,\"uniques\":3},{\"referrer\":\"stackoverflow.com\",\"count\":2,\"uniques\":2},{\"referrer\":\"eggsonbread.com\",\"count\":1,\"uniques\":1},{\"referrer\":\"yandex.ru\",\"count\":1,\"uniques\":1}]" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Get users with access to the protected branch", + "scope": "repos", + "id": "getUsersWithAccessToProtectedBranch", + "method": "GET", + "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://docs.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/branches/branch-protection#get-users-with-access-to-the-protected-branch", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "branch", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"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}]" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get page views", + "scope": "repos", + "id": "getViews", + "method": "GET", + "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/metrics/traffic#get-page-views", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per", + "description": "The time frame to display results for.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["day", "week"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"count\":14850,\"uniques\":3782,\"views\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":440,\"uniques\":143},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":1308,\"uniques\":414},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":1486,\"uniques\":452},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":1170,\"uniques\":401},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":868,\"uniques\":266},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":495,\"uniques\":157},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":524,\"uniques\":175},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":1263,\"uniques\":412},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":1402,\"uniques\":417},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":1394,\"uniques\":424},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":1492,\"uniques\":448},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":1153,\"uniques\":332},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":566,\"uniques\":168},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":675,\"uniques\":184},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":614,\"uniques\":237}]}" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a repository webhook", + "scope": "repos", + "id": "getWebhook", + "method": "GET", + "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/webhooks/repo-config#get-a-webhook-configuration-for-a-repository).\"", + "documentationUrl": "https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "hook_id", + "description": "The unique identifier of the hook.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" } ] }, - { "code": 403, "description": "Forbidden", "examples": null } + { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null }, { - "name": "Get users with access to the protected branch", + "name": "Get a webhook configuration for a repository", "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", + "id": "getWebhookConfigForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", "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://docs.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/branches/branch-protection#list-users-with-access-to-the-protected-branch", + "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/webhooks/repos#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/webhooks/repo-config#get-a-webhook-configuration-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -57786,10 +57932,10 @@ "deprecated": null }, { - "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).", + "name": "hook_id", + "description": "The unique identifier of the hook.", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -57805,25 +57951,24 @@ "description": "Response", "examples": [ { - "data": "[{\"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}]" + "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" } ] - }, - { "code": 404, "description": "Resource not found", "examples": null } + } ], "renamed": null }, { - "name": "Get page views", + "name": "Get a delivery for a repository webhook", "scope": "repos", - "id": "getViews", + "id": "getWebhookDelivery", "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/views", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", "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/metrics/traffic#get-page-views", + "description": "Returns a delivery for a webhook configured in a repository.", + "documentationUrl": "https://docs.github.com/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook", "previews": [], "headers": [], "parameters": [ @@ -57854,12 +57999,25 @@ "deprecated": null }, { - "name": "per", - "description": "The time frame to display results for.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["day", "week"], + "name": "hook_id", + "description": "The unique identifier of the hook.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "delivery_id", + "description": "", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -57873,25 +58031,31 @@ "description": "Response", "examples": [ { - "data": "{\"count\":14850,\"uniques\":3782,\"views\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":440,\"uniques\":143},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":1308,\"uniques\":414},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":1486,\"uniques\":452},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":1170,\"uniques\":401},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":868,\"uniques\":266},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":495,\"uniques\":157},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":524,\"uniques\":175},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":1263,\"uniques\":412},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":1402,\"uniques\":417},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":1394,\"uniques\":424},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":1492,\"uniques\":448},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":1153,\"uniques\":332},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":566,\"uniques\":168},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":675,\"uniques\":184},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":614,\"uniques\":237}]}" + "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" } ] }, - { "code": 403, "description": "Forbidden", "examples": null } + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } ], "renamed": null }, { - "name": "Get a repository webhook", + "name": "List repository activities", "scope": "repos", - "id": "getWebhook", + "id": "listActivities", "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "url": "/repos/{owner}/{repo}/activity", "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/webhooks/repos#get-a-repository-webhook", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity).\"", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-activities", "previews": [], "headers": [], "parameters": [ @@ -57922,53 +58086,24 @@ "deprecated": null }, { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for a repository", - "scope": "repos", - "id": "getWebhookConfigForRepo", - "method": "GET", - "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/webhooks/repo-config#get-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -57977,11 +58112,11 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -57990,52 +58125,24 @@ "deprecated": null }, { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a delivery for a repository webhook", - "scope": "repos", - "id": "getWebhookDelivery", - "method": "GET", - "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/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", + "name": "ref", + "description": "The Git reference for the activities you want to list.\n\nThe `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -58044,11 +58151,11 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", + "name": "actor", + "description": "The GitHub username to use to filter by the actor who performed the activity.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -58057,12 +58164,12 @@ "deprecated": null }, { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["day", "week", "month", "quarter", "year"], "allowNull": false, "mapToData": null, "validation": null, @@ -58070,12 +58177,19 @@ "deprecated": null }, { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "activity_type", + "description": "The activity type to filter by.\n\nFor example, you can choose to filter by \"force_push\", to see all force pushes to the repository.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "push", + "force_push", + "branch_creation", + "branch_deletion", + "pr_merge", + "merge_queue_merge" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -58089,12 +58203,10 @@ "description": "Response", "examples": [ { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"before\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"after\":\"827efc6d56897b048c772eb4087f854f46256132\",\"ref\":\"refs/heads/main\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"push_type\":\"normal\",\"pusher\":{\"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}}]" } ] }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", @@ -58545,7 +58657,7 @@ "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.", + "description": "Commit Comments use [these custom media types](https://docs.github.com/rest/overview/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/commits/comments#list-commit-comments-for-a-repository", "previews": [], "headers": [], @@ -58658,7 +58770,7 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", "in": "PATH", "type": "string", "required": true, @@ -58804,7 +58916,7 @@ }, { "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "description": "Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -58883,7 +58995,7 @@ "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 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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-contributors", "previews": [], "headers": [], "parameters": [ @@ -58956,7 +59068,7 @@ "responses": [ { "code": 200, - "description": "if repository contains content", + "description": "If repository contains content", "examples": [ { "data": "[{\"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,\"contributions\":32}]" @@ -58983,7 +59095,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".", - "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations", + "documentationUrl": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment", "previews": [], "headers": [], "parameters": [ @@ -59076,7 +59188,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/deploy-keys#list-deploy-keys", + "documentationUrl": "https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys", "previews": [], "headers": [], "parameters": [ @@ -59475,7 +59587,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repositories-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -59632,7 +59744,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-organization-repositories", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-organization-repositories", "previews": [], "headers": [], "parameters": [ @@ -59738,7 +59850,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repositories-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -59844,7 +59956,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-forks", + "documentationUrl": "https://docs.github.com/rest/repos/forks#list-forks", "previews": [], "headers": [], "parameters": [ @@ -60081,7 +60193,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-languages", "previews": [], "headers": [], "parameters": [ @@ -60131,7 +60243,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists builts of a GitHub Pages site.\n\nA token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission.", - "documentationUrl": "https://docs.github.com/rest/pages#list-github-pages-builds", + "documentationUrl": "https://docs.github.com/rest/pages/pages#list-apiname-pages-builds", "previews": [], "headers": [], "parameters": [ @@ -60211,7 +60323,7 @@ "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/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-public-repositories", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-public-repositories", "previews": [], "headers": [], "parameters": [ @@ -60257,7 +60369,7 @@ "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, will only return open pull requests associated with the commit.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.\n\nTo list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name.", "documentationUrl": "https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], @@ -60351,7 +60463,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-release-assets", + "documentationUrl": "https://docs.github.com/rest/releases/assets#list-release-assets", "previews": [], "headers": [], "parameters": [ @@ -60443,8 +60555,8 @@ "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", + "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/repos/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/releases/releases#list-releases", "previews": [], "headers": [], "parameters": [ @@ -60525,7 +60637,7 @@ "deprecationDate": null, "removalDate": null, "description": "This returns the tag protection states of a repository.\n\nThis information is only available to repository administrators.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-tag-protection-state-of-a-repository", + "documentationUrl": "https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -60577,7 +60689,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-tags", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-tags", "previews": [], "headers": [], "parameters": [ @@ -60657,7 +60769,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the teams that have access to the specified repository and that are also visible to the authenticated user.\n\nFor a public repository, a team is listed only if that team added the public repository explicitly.\n\nPersonal access tokens require the following scopes:\n* `public_repo` to call this endpoint on a public repository\n* `repo` to call this endpoint on a private repository (this scope also includes public repositories)\n\nThis endpoint is not compatible with fine-grained personal access tokens.", - "documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-teams", + "documentationUrl": "https://docs.github.com/rest/repos/repos#list-repository-teams", "previews": [], "headers": [], "parameters": [ @@ -61816,7 +61928,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/repos#replace-all-repository-topics", + "documentationUrl": "https://docs.github.com/rest/repos/repos#replace-all-repository-topics", "previews": [], "headers": [], "parameters": [ @@ -61887,7 +61999,7 @@ "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/pages#request-a-github-pages-build", + "documentationUrl": "https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build", "previews": [], "headers": [], "parameters": [ @@ -62404,8 +62516,8 @@ "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://docs.github.com/articles/about-repository-transfers/).", - "documentationUrl": "https://docs.github.com/rest/reference/repos#transfer-a-repository", + "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://docs.github.com/articles/about-repository-transfers/).\nYou must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.", + "documentationUrl": "https://docs.github.com/rest/repos/repos#transfer-a-repository", "previews": [], "headers": [], "parameters": [ @@ -62497,7 +62609,7 @@ "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.", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint.", "documentationUrl": "https://docs.github.com/rest/repos/repos#update-a-repository", "previews": [], "headers": [], @@ -63521,7 +63633,7 @@ "deprecationDate": null, "removalDate": null, "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy", + "documentationUrl": "https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy", "previews": [], "headers": [], "parameters": [ @@ -63614,7 +63726,7 @@ "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).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions.", - "documentationUrl": "https://docs.github.com/rest/pages#update-information-about-a-github-pages-site", + "documentationUrl": "https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site", "previews": [], "headers": [], "parameters": [ @@ -63800,7 +63912,7 @@ "deprecationDate": null, "removalDate": null, "description": "Update a ruleset for an organization.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#update-organization-ruleset", + "documentationUrl": "https://docs.github.com/rest/orgs/rules#update-an-organization-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -63887,7 +63999,7 @@ "description": "The ID of the actor that can bypass a ruleset", "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -63900,8 +64012,21 @@ "description": "The type of actor that can bypass a ruleset", "in": "BODY", "type": "string", - "required": false, - "enum": ["Team", "Integration"], + "required": true, + "enum": ["RepositoryRole", "Team", "Integration", "OrganizationAdmin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_actors[].bypass_mode", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["always", "pull_request"], "allowNull": false, "mapToData": null, "validation": null, @@ -63910,7 +64035,7 @@ }, { "name": "conditions", - "description": "Conditions for a organization ruleset", + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\n", "in": "BODY", "type": "object", "required": false, @@ -64162,7 +64287,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" + "data": "{\"id\":21,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Organization\",\"source\":\"my-org\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]},\"repository_name\":{\"include\":[\"important_repository\",\"another_important_repository\"],\"exclude\":[\"unimportant_repository\"],\"protected\":true}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/orgs/my-org/rulesets/21\"},\"html\":{\"href\":\"https://github.com/organizations/my-org/settings/rules/21\"}},\"created_at\":\"2023-08-15T08:43:03Z\",\"updated_at\":\"2023-09-23T16:29:47Z\"}" } ] }, @@ -64409,7 +64534,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/releases#update-a-release", "previews": [], "headers": [], "parameters": [ @@ -64585,7 +64710,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/releases/assets#update-a-release-asset", "previews": [], "headers": [], "parameters": [ @@ -64691,7 +64816,7 @@ "deprecationDate": null, "removalDate": null, "description": "Update a ruleset for a repository.", - "documentationUrl": "https://docs.github.com/rest/repos/rules#update-repository-ruleset", + "documentationUrl": "https://docs.github.com/rest/repos/rules#update-a-repository-ruleset", "previews": [], "headers": [], "parameters": [ @@ -64773,19 +64898,6 @@ "alias": null, "deprecated": null }, - { - "name": "bypass_mode", - "description": "The permission level required to bypass this ruleset. \"repository\" allows those with bypass permission at the repository level to bypass. \"organization\" allows those with bypass permission at the organization level to bypass. \"none\" prevents anyone from bypassing.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["none", "repository", "organization"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "bypass_actors", "description": "The actors that can bypass the rules in this ruleset", @@ -64804,7 +64916,7 @@ "description": "The ID of the actor that can bypass a ruleset", "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -64817,8 +64929,21 @@ "description": "The type of actor that can bypass a ruleset", "in": "BODY", "type": "string", - "required": false, - "enum": ["Team", "Integration"], + "required": true, + "enum": ["RepositoryRole", "Team", "Integration", "OrganizationAdmin"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "bypass_actors[].bypass_mode", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["always", "pull_request"], "allowNull": false, "mapToData": null, "validation": null, @@ -65118,7 +65243,7 @@ "description": "Response", "examples": [ { - "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_mode\":\"repository\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" + "data": "{\"id\":42,\"name\":\"super cool ruleset\",\"target\":\"branch\",\"source_type\":\"Repository\",\"source\":\"monalisa/my-repo\",\"enforcement\":\"active\",\"bypass_actors\":[{\"actor_id\":234,\"actor_type\":\"Team\",\"bypass_mode\":\"always\"}],\"conditions\":{\"ref_name\":{\"include\":[\"refs/heads/main\",\"refs/heads/master\"],\"exclude\":[\"refs/heads/dev*\"]}},\"rules\":[{\"type\":\"commit_author_email_pattern\",\"parameters\":{\"operator\":\"contains\",\"pattern\":\"github\"}}],\"node_id\":\"RRS_lACkVXNlcgQB\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/monalisa/my-repo/rulesets/42\"},\"html\":{\"href\":\"https://github.com/monalisa/my-repo/rules/42\"}},\"created_at\":\"2023-07-15T08:43:03Z\",\"updated_at\":\"2023-08-23T16:29:47Z\"}" } ] }, @@ -65417,7 +65542,7 @@ "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).\"", + "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/webhooks/repo-config#update-a-webhook-configuration-for-a-repository).\"", "documentationUrl": "https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook", "previews": [], "headers": [], @@ -65463,7 +65588,7 @@ }, { "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/rest/reference/repos#create-hook-config-params).", + "description": "Key/value pairs to provide settings for this webhook.", "in": "BODY", "type": "object", "required": false, @@ -65633,7 +65758,7 @@ "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.", + "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/webhooks/repos#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/webhooks/repo-config#update-a-webhook-configuration-for-a-repository", "previews": [], "headers": [], @@ -65752,8 +65877,8 @@ "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/releases/releases#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* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \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", + "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/releases/releases#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 release assets](https://docs.github.com/rest/releases/assets#list-release-assets)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api).\n* To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). \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/releases/assets#upload-a-release-asset", "previews": [], "headers": [], "parameters": [ @@ -65876,14 +66001,14 @@ "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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-code", + "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/search/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\nConsiderations 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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "documentationUrl": "https://docs.github.com/rest/search/search#search-code", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -65896,7 +66021,7 @@ }, { "name": "sort", - "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -65977,14 +66102,14 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Find commits via various criteria on the default branch (usually `main`). 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", + "description": "Find commits via various criteria on the default branch (usually `main`). 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/search/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/search/search#search-commits", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -65997,7 +66122,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -66071,14 +66196,14 @@ "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", + "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/search/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 requests made by GitHub Apps with a user access token, 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/search/search#search-issues-and-pull-requests", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -66091,7 +66216,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -66184,8 +66309,8 @@ "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", + "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/search/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/search/search#search-labels", "previews": [], "headers": [], "parameters": [ @@ -66204,7 +66329,7 @@ }, { "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", "in": "QUERY", "type": "string", "required": true, @@ -66217,7 +66342,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -66298,14 +66423,14 @@ "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.", - "documentationUrl": "https://docs.github.com/rest/reference/search#search-repositories", + "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/search/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.", + "documentationUrl": "https://docs.github.com/rest/search/search#search-repositories", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -66318,7 +66443,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -66398,14 +66523,14 @@ "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://docs.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", + "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://docs.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/search/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/search/search#search-topics", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query).", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query).", "in": "QUERY", "type": "string", "required": true, @@ -66466,14 +66591,14 @@ "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**, public **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", + "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**, public **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/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/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.\n\nThis endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search).\"", + "documentationUrl": "https://docs.github.com/rest/search/search#search-users", "previews": [], "headers": [], "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -66486,7 +66611,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)", "in": "QUERY", "type": "string", "required": false, @@ -66567,7 +66692,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` 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", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -66641,7 +66766,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).", - "documentationUrl": "https://docs.github.com/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-enterprise", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise", "previews": [], "headers": [], "parameters": [ @@ -66788,7 +66913,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` 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-an-organization", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization", "previews": [], "headers": [], "parameters": [ @@ -66948,7 +67073,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` 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", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -67125,7 +67250,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` 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-locations-for-a-secret-scanning-alert", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -67224,7 +67349,7 @@ "deprecationDate": null, "removalDate": null, "description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` 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", + "documentationUrl": "https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert", "previews": [], "headers": [], "parameters": [ @@ -67446,7 +67571,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ], "allowNull": false, "mapToData": null, @@ -67552,7 +67678,7 @@ "description": "Response", "examples": [ { - "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A newly discovered vulnerability\",\"description\":\"A more in-depth description of what the problem is.\",\"severity\":\"high\",\"author\":{\"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},\"publisher\":null,\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":null}],\"state\":\"triage\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":null,\"closed_at\":null,\"withdrawn_at\":null,\"submission\":{\"accepted\":false},\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"npm\",\"name\":\"a-package\"},\"vulnerable_version_range\":\"< 1.0.0\",\"patched_versions\":\"1.0.0\",\"vulnerable_functions\":[\"important_function\"]}],\"cvss\":null,\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"finder\"}],\"credits_detailed\":[{\"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},\"type\":\"finder\",\"state\":\"accepted\"}]}" + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A newly discovered vulnerability\",\"description\":\"A more in-depth description of what the problem is.\",\"severity\":\"high\",\"author\":{\"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},\"publisher\":null,\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":null}],\"state\":\"triage\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":null,\"closed_at\":null,\"withdrawn_at\":null,\"submission\":{\"accepted\":false},\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"npm\",\"name\":\"a-package\"},\"vulnerable_version_range\":\"< 1.0.0\",\"patched_versions\":\"1.0.0\",\"vulnerable_functions\":[\"important_function\"]}],\"cvss\":null,\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"finder\"}],\"credits_detailed\":[{\"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},\"type\":\"finder\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"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}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}" } ] }, @@ -67607,9 +67733,417 @@ "deprecated": null }, { - "name": "summary", - "description": "A short summary of the advisory.", - "in": "BODY", + "name": "summary", + "description": "A short summary of the advisory.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A detailed description of what the advisory impacts.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "cve_id", + "description": "The Common Vulnerabilities and Exposures (CVE) ID.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities", + "description": "A product affected by the vulnerability detailed in a repository security advisory.", + "in": "BODY", + "type": "object[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].package", + "description": "The name of the package affected by the vulnerability.", + "in": "BODY", + "type": "object", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].package.ecosystem", + "description": "The package's language or package management ecosystem.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "rubygems", + "npm", + "pip", + "maven", + "nuget", + "composer", + "go", + "rust", + "erlang", + "actions", + "pub", + "other", + "swift" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].package.name", + "description": "The unique package name within its ecosystem.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].vulnerable_version_range", + "description": "The range of the package versions affected by the vulnerability.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].patched_versions", + "description": "The package version(s) that resolve the vulnerability.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "vulnerabilities[].vulnerable_functions", + "description": "The functions in the package that are affected.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "cwe_ids", + "description": "A list of Common Weakness Enumeration (CWE) IDs.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "credits", + "description": "A list of users receiving credit for their participation in the security advisory.", + "in": "BODY", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "credits[].login", + "description": "The username of the user credited.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "credits[].type", + "description": "The type of credit the user is receiving.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "analyst", + "finder", + "reporter", + "coordinator", + "remediation_developer", + "remediation_reviewer", + "remediation_verifier", + "tool", + "sponsor", + "other" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "severity", + "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["critical", "high", "medium", "low"], + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "cvss_vector_string", + "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [ + { + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}" + } + ] + }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Request a CVE for a repository security advisory", + "scope": "securityAdvisories", + "id": "createRepositoryAdvisoryCveRequest", + "method": "POST", + "url": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.\n\nIn order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.", + "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 422, + "description": "Validation failed, or the endpoint has been spammed.", + "examples": null + } + ], + "renamed": null + }, + { + "name": "Get a global security advisory", + "scope": "securityAdvisories", + "id": "getGlobalAdvisory", + "method": "GET", + "url": "/advisories/{ghsa_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier.", + "documentationUrl": "https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/advisories/GHSA-abcd-1234-efgh\",\"repository_advisory_url\":\"https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"type\":\"reviewed\",\"severity\":\"high\",\"source_code_location\":\"https://github.com/project/a-package\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"references\":[\"https://nvd.nist.gov/vuln/detail/CVE-2050-00000\"],\"published_at\":\"2023-03-23T02:30:56Z\",\"updated_at\":\"2023-03-24T02:30:56Z\",\"github_reviewed_at\":\"2023-03-23T02:30:56Z\",\"nvd_published_at\":\"2023-03-25T02:30:56Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"npm\",\"name\":\"a-package\"},\"first_patched_version\":\"1.0.3\",\"vulnerable_version_range\":\"<=1.0.2\",\"vulnerable_functions\":[\"a_function\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H\",\"score\":7.6},\"cwes\":[{\"cwe_id\":\"CWE-400\",\"name\":\"Uncontrolled Resource Consumption\"}],\"credits\":[{\"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},\"type\":\"analyst\"}]}" + } + ] + }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "Get a repository security advisory", + "scope": "securityAdvisories", + "id": "getRepositoryAdvisory", + "method": "GET", + "url": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\nYou can access any published security advisory on a public repository.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission\nin order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.\n\nYou can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a\ncollaborator on the security advisory.", + "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ghsa_id", + "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -67618,13 +68152,43 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}" + } + ] }, + { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null } + ], + "renamed": null + }, + { + "name": "List global security advisories", + "scope": "securityAdvisories", + "id": "listGlobalAdvisories", + "method": "GET", + "url": "/advisories", + "isDeprecated": false, + "deprecationDate": null, + "removalDate": null, + "description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"", + "documentationUrl": "https://docs.github.com/rest/security-advisories/global-advisories#list-global-security-advisories", + "previews": [], + "headers": [], + "parameters": [ { - "name": "description", - "description": "A detailed description of what the advisory impacts.", - "in": "BODY", + "name": "ghsa_id", + "description": "If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -67633,25 +68197,12 @@ "deprecated": null }, { - "name": "cve_id", - "description": "The Common Vulnerabilities and Exposures (CVE) ID.", - "in": "BODY", + "name": "type", + "description": "If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "vulnerabilities", - "description": "A product affected by the vulnerability detailed in a repository security advisory.", - "in": "BODY", - "type": "object[]", - "required": true, - "enum": null, + "enum": ["reviewed", "malware", "unreviewed"], "allowNull": false, "mapToData": null, "validation": null, @@ -67659,11 +68210,11 @@ "deprecated": null }, { - "name": "vulnerabilities[].package", - "description": "The name of the package affected by the vulnerability.", - "in": "BODY", - "type": "object", - "required": true, + "name": "cve_id", + "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -67672,24 +68223,24 @@ "deprecated": null }, { - "name": "vulnerabilities[].package.ecosystem", - "description": "The package's language or package management ecosystem.", - "in": "BODY", + "name": "ecosystem", + "description": "If specified, only advisories for these ecosystems will be returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": [ - "rubygems", - "npm", - "pip", - "maven", - "nuget", + "actions", "composer", - "go", - "rust", "erlang", - "actions", + "go", + "maven", + "npm", + "nuget", + "other", + "pip", "pub", - "other" + "rubygems", + "rust" ], "allowNull": false, "mapToData": null, @@ -67698,89 +68249,89 @@ "deprecated": null }, { - "name": "vulnerabilities[].package.name", - "description": "The unique package name within its ecosystem.", - "in": "BODY", + "name": "severity", + "description": "If specified, only advisories with these severities will be returned.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, - "allowNull": true, + "enum": ["unknown", "low", "medium", "high", "critical"], + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "vulnerabilities[].vulnerable_version_range", - "description": "The range of the package versions affected by the vulnerability.", - "in": "BODY", - "type": "string", + "name": "cwes", + "description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`", + "in": "QUERY", + "type": null, "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "vulnerabilities[].patched_versions", - "description": "The package version(s) that resolve the vulnerability.", - "in": "BODY", - "type": "string", + "name": "is_withdrawn", + "description": "Whether to only return advisories that have been withdrawn.", + "in": "QUERY", + "type": "boolean", "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "vulnerabilities[].vulnerable_functions", - "description": "The functions in the package that are affected.", - "in": "BODY", - "type": "string[]", + "name": "affects", + "description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`", + "in": "QUERY", + "type": null, "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "cwe_ids", - "description": "A list of Common Weakness Enumeration (CWE) IDs.", - "in": "BODY", - "type": "string[]", + "name": "published", + "description": "If specified, only return advisories that were published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "QUERY", + "type": "string", "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "credits", - "description": "A list of users receiving credit for their participation in the security advisory.", - "in": "BODY", - "type": "object[]", + "name": "updated", + "description": "If specified, only return advisories that were updated on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "QUERY", + "type": "string", "required": false, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "credits[].login", - "description": "The username of the user credited.", - "in": "BODY", + "name": "modified", + "description": "If specified, only show advisories that were updated or published on a date or date range.\n\nFor more information on the syntax of the date range, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -67789,23 +68340,12 @@ "deprecated": null }, { - "name": "credits[].type", - "description": "The type of credit the user is receiving.", - "in": "BODY", + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "QUERY", "type": "string", - "required": true, - "enum": [ - "analyst", - "finder", - "reporter", - "coordinator", - "remediation_developer", - "remediation_reviewer", - "remediation_verifier", - "tool", - "sponsor", - "other" - ], + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -67813,26 +68353,52 @@ "deprecated": null }, { - "name": "severity", - "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.", - "in": "BODY", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["critical", "high", "medium", "low"], - "allowNull": true, + "enum": null, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "cvss_vector_string", - "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.", - "in": "BODY", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, - "allowNull": true, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["updated", "published"], + "allowNull": false, "mapToData": null, "validation": null, "alias": null, @@ -67841,41 +68407,40 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "Response", "examples": [ { - "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}]}" + "data": "[{\"id\":1,\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/advisories/GHSA-abcd-1234-efgh\",\"repository_advisory_url\":\"https://api.github.com/repos/project/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"summary\":\"Heartbleed security advisory\",\"description\":\"This bug allows an attacker to read portions of the affected server’s memory, potentially disclosing sensitive information.\",\"type\":\"reviewed\",\"severity\":\"high\",\"source_code_location\":\"https://github.com/project/a-package\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"references\":[\"https://nvd.nist.gov/vuln/detail/CVE-2050-00000\"],\"published_at\":\"2023-03-23T02:30:56Z\",\"updated_at\":\"2023-03-24T02:30:56Z\",\"github_reviewed_at\":\"2023-03-23T02:30:56Z\",\"nvd_published_at\":\"2023-03-25T02:30:56Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"npm\",\"name\":\"a-package\"},\"first_patched_version\":\"1.0.3\",\"vulnerable_version_range\":\"<=1.0.2\",\"vulnerable_functions\":[\"a_function\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:H/PR:H/UI:R/S:C/C:H/I:H/A:H\",\"score\":7.6},\"cwes\":[{\"cwe_id\":\"CWE-400\",\"name\":\"Uncontrolled Resource Consumption\"}],\"credits\":[{\"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},\"type\":\"analyst\"}]}]" } ] }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, { "code": 422, "description": "Validation failed, or the endpoint has been spammed.", "examples": null - } + }, + { "code": 429, "description": "Too many requests", "examples": null } ], "renamed": null }, { - "name": "Get a repository security advisory", + "name": "List repository security advisories for an organization", "scope": "securityAdvisories", - "id": "getRepositoryAdvisory", + "id": "listOrgRepositoryAdvisories", "method": "GET", - "url": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}", + "url": "/orgs/{org}/security-advisories", "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier.\nYou can access any published security advisory on a public repository.\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission\nin order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to.\n\nYou can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a\ncollaborator on the security advisory.", - "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory", + "description": "Lists repository security advisories for an organization.\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission.", + "documentationUrl": "https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", + "name": "org", + "description": "The organization name. The name is not case sensitive.", "in": "PATH", "type": "string", "required": true, @@ -67887,11 +68452,37 @@ "deprecated": null }, { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "PATH", + "name": "direction", + "description": "The direction to sort the results by.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "The property to sort the results by.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated", "published"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -67900,17 +68491,43 @@ "deprecated": null }, { - "name": "ghsa_id", - "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.", - "in": "PATH", + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of advisories to return per page.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null + }, + { + "name": "state", + "description": "Filter by the state of the repository advisories. Only advisories of this state will be returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["triage", "draft", "published", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -67919,11 +68536,12 @@ "description": "Response", "examples": [ { - "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}]}" + "data": "[{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]},{\"ghsa_id\":\"GHSA-1234-5678-9012\",\"cve_id\":\"CVE-2051-0000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"low\",\"author\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"publisher\":{\"login\":\"monalisa\",\"id\":3,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":false},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-1234-5678-9012\"},{\"type\":\"CVE\",\"value\":\"CVE-2051-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-03T00:00:00Z\",\"updated_at\":\"2020-01-04T00:00:00Z\",\"published_at\":\"2020-01-04T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":[{\"accepted\":true}],\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N\",\"score\":1.6},\"cwes\":[{\"cwe_id\":\"CWE-456\",\"name\":\"A CWE 2.0\"}],\"cwe_ids\":[\"CWE-456\"],\"credits\":[{\"login\":\"monauser\",\"type\":\"reporter\"}],\"credits_detailed\":[{\"user\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"type\":\"reporter\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}]" } ] }, - { "code": 403, "description": "Forbidden", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, + { "code": 400, "description": "Bad Request", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null } ], "renamed": null @@ -68053,7 +68671,7 @@ "description": "Response", "examples": [ { - "data": "[{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}]},{\"ghsa_id\":\"GHSA-1234-5678-9012\",\"cve_id\":\"CVE-2051-0000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"low\",\"author\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"publisher\":{\"login\":\"monalisa\",\"id\":3,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":false},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-1234-5678-9012\"},{\"type\":\"CVE\",\"value\":\"CVE-2051-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-03T00:00:00Z\",\"updated_at\":\"2020-01-04T00:00:00Z\",\"published_at\":\"2020-01-04T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":[{\"accepted\":true}],\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N\",\"score\":1.6},\"cwes\":[{\"cwe_id\":\"CWE-456\",\"name\":\"A CWE 2.0\"}],\"cwe_ids\":[\"CWE-456\"],\"credits\":[{\"login\":\"monauser\",\"type\":\"reporter\"}],\"credits_detailed\":[{\"user\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"type\":\"reporter\",\"state\":\"accepted\"}]}]" + "data": "[{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]},{\"ghsa_id\":\"GHSA-1234-5678-9012\",\"cve_id\":\"CVE-2051-0000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"low\",\"author\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"publisher\":{\"login\":\"monalisa\",\"id\":3,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":false},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-1234-5678-9012\"},{\"type\":\"CVE\",\"value\":\"CVE-2051-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-03T00:00:00Z\",\"updated_at\":\"2020-01-04T00:00:00Z\",\"published_at\":\"2020-01-04T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":[{\"accepted\":true}],\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N\",\"score\":1.6},\"cwes\":[{\"cwe_id\":\"CWE-456\",\"name\":\"A CWE 2.0\"}],\"cwe_ids\":[\"CWE-456\"],\"credits\":[{\"login\":\"monauser\",\"type\":\"reporter\"}],\"credits_detailed\":[{\"user\":{\"login\":\"monauser\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monauser\",\"html_url\":\"https://github.com/monauser\",\"followers_url\":\"https://api.github.com/users/monauser/followers\",\"following_url\":\"https://api.github.com/users/monauser/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monauser/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monauser/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monauser/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monauser/orgs\",\"repos_url\":\"https://api.github.com/users/monauser/repos\",\"events_url\":\"https://api.github.com/users/monauser/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monauser/received_events\",\"type\":\"User\",\"site_admin\":false},\"type\":\"reporter\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}]" } ] }, @@ -68199,7 +68817,8 @@ "erlang", "actions", "pub", - "other" + "other", + "swift" ], "allowNull": false, "mapToData": null, @@ -68360,6 +68979,32 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "collaborating_users", + "description": "A list of usernames who have been granted write access to the advisory.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "collaborating_teams", + "description": "A list of team slugs which have been granted write access to the advisory.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -68368,10 +69013,10 @@ "description": "Response", "examples": [ { - "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}]}" + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}" }, { - "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}]}" + "data": "{\"ghsa_id\":\"GHSA-abcd-1234-efgh\",\"cve_id\":\"CVE-2050-00000\",\"url\":\"https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh\",\"html_url\":\"https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh\",\"summary\":\"A short summary of the advisory.\",\"description\":\"A detailed description of what the advisory entails.\",\"severity\":\"critical\",\"author\":{\"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},\"publisher\":{\"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},\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-abcd-1234-efgh\"},{\"type\":\"CVE\",\"value\":\"CVE-2050-00000\"}],\"state\":\"published\",\"created_at\":\"2020-01-01T00:00:00Z\",\"updated_at\":\"2020-01-02T00:00:00Z\",\"published_at\":\"2020-01-03T00:00:00Z\",\"closed_at\":null,\"withdrawn_at\":null,\"submission\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"a-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.1\",\"patched_versions\":\"1.0.1\",\"vulnerable_functions\":[\"function1\"]},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"another-package\"},\"vulnerable_version_range\":\">= 1.0.0, < 1.0.2\",\"patched_versions\":\"1.0.2\",\"vulnerable_functions\":[\"function2\"]}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\"score\":9.8},\"cwes\":[{\"cwe_id\":\"CWE-123\",\"name\":\"A CWE\"}],\"cwe_ids\":[\"CWE-123\"],\"credits\":[{\"login\":\"octocat\",\"type\":\"analyst\"}],\"credits_detailed\":[{\"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},\"type\":\"analyst\",\"state\":\"accepted\"}],\"collaborating_users\":[{\"login\":\"octokitten\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octokitten_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octokitten\",\"html_url\":\"https://github.com/octokitten\",\"followers_url\":\"https://api.github.com/users/octokitten/followers\",\"following_url\":\"https://api.github.com/users/octokitten/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octokitten/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octokitten/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octokitten/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octokitten/orgs\",\"repos_url\":\"https://api.github.com/users/octokitten/repos\",\"events_url\":\"https://api.github.com/users/octokitten/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octokitten/received_events\",\"type\":\"User\",\"site_admin\":false}],\"collaborating_teams\":[{\"name\":\"Justice League\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"notification_setting\":\"notifications_enabled\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"permission\":\"admin\",\"parent\":null}]}" } ] }, @@ -68401,8 +69046,8 @@ "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://docs.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://docs.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", + "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/teams/members#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://docs.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://docs.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/teams/members#add-team-member-legacy", "previews": [], "headers": [], "parameters": [ @@ -68459,7 +69104,7 @@ "deprecationDate": null, "removalDate": null, "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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://docs.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", + "documentationUrl": "https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -68548,8 +69193,8 @@ "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://docs.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://docs.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", + "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/teams/members#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://docs.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://docs.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/teams/members#add-or-update-team-membership-for-a-user-legacy", "previews": [], "headers": [], "parameters": [ @@ -68627,7 +69272,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions", "previews": [], "headers": [], "parameters": [ @@ -68691,7 +69336,7 @@ "description": "Forbidden if the project is not owned by the organization", "examples": [ { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions\"}" + "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions\"}" } ] } @@ -68707,8 +69352,8 @@ "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", + "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/teams/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/teams/teams#add-or-update-team-project-permissions-legacy", "previews": [], "headers": [], "parameters": [ @@ -68759,7 +69404,7 @@ "description": "Forbidden if the project is not owned by the organization", "examples": [ { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/rest/reference/teams#add-or-update-team-project-permissions\"}" + "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions\"}" } ] }, @@ -68782,7 +69427,7 @@ "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://docs.github.com/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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions", "previews": [], "headers": [], "parameters": [ @@ -68864,8 +69509,8 @@ "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", + "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/teams/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/teams/teams#add-or-update-team-repository-permissions-legacy", "previews": [], "headers": [], "parameters": [ @@ -68943,7 +69588,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project", "previews": [], "headers": [], "parameters": [ @@ -69014,8 +69659,8 @@ "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", + "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/teams/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/teams/teams#check-team-permissions-for-a-project-legacy", "previews": [], "headers": [], "parameters": [ @@ -69074,7 +69719,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -69163,8 +69808,8 @@ "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", + "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/teams/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/teams/teams#check-team-permissions-for-a-repository-legacy", "previews": [], "headers": [], "parameters": [ @@ -69241,7 +69886,7 @@ "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://docs.github.com/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://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-team", + "documentationUrl": "https://docs.github.com/rest/teams/teams#create-a-team", "previews": [], "headers": [], "parameters": [ @@ -69392,7 +70037,7 @@ "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/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", + "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -69471,8 +70116,8 @@ "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/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", + "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/teams/discussion-comments#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/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/teams/discussion-comments#create-a-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -69539,7 +70184,7 @@ "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/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", + "documentationUrl": "https://docs.github.com/rest/teams/discussions#create-a-discussion", "previews": [], "headers": [], "parameters": [ @@ -69631,8 +70276,8 @@ "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/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", + "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/teams/discussions#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/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/teams/discussions#create-a-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -69712,7 +70357,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -69781,8 +70426,8 @@ "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", + "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/teams/discussion-comments#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/teams/discussion-comments#delete-a-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -69839,7 +70484,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussions#delete-a-discussion", "previews": [], "headers": [], "parameters": [ @@ -69895,8 +70540,8 @@ "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", + "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/teams/discussions#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/teams/discussions#delete-a-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -69940,7 +70585,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#delete-a-team", "previews": [], "headers": [], "parameters": [ @@ -69983,8 +70628,8 @@ "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", + "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/teams/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/teams/teams#delete-a-team-legacy", "previews": [], "headers": [], "parameters": [ @@ -70023,7 +70668,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `\"My TEam Näme\"` would become `my-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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#get-a-team-by-name", "previews": [], "headers": [], "parameters": [ @@ -70078,7 +70723,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -70157,8 +70802,8 @@ "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", + "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/teams/discussion-comments#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/teams/discussion-comments#get-a-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -70225,7 +70870,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussions#get-a-discussion", "previews": [], "headers": [], "parameters": [ @@ -70291,8 +70936,8 @@ "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", + "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/teams/discussions#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/teams/discussions#get-a-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -70345,8 +70990,8 @@ "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", + "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/teams/teams#get-a-team-by-name) endpoint.", + "documentationUrl": "https://docs.github.com/rest/teams/teams#get-a-team-legacy", "previews": [], "headers": [], "parameters": [ @@ -70387,8 +71032,8 @@ "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", + "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/teams/members#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/teams/members#get-team-member-legacy", "previews": [], "headers": [], "parameters": [ @@ -70438,8 +71083,8 @@ "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", + "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 [Create a team](https://docs.github.com/rest/teams/teams#create-a-team).", + "documentationUrl": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -70510,8 +71155,8 @@ "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", + "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/teams/members#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/teams/teams#create-a-team).", + "documentationUrl": "https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy", "previews": [], "headers": [], "parameters": [ @@ -70566,7 +71211,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-teams", "previews": [], "headers": [], "parameters": [ @@ -70634,7 +71279,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-child-teams", "previews": [], "headers": [], "parameters": [ @@ -70713,8 +71358,8 @@ "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", + "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/teams/teams#list-child-teams) endpoint.", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-child-teams-legacy", "previews": [], "headers": [], "parameters": [ @@ -70788,7 +71433,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments", "previews": [], "headers": [], "parameters": [ @@ -70893,8 +71538,8 @@ "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", + "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/teams/discussion-comments#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/teams/discussion-comments#list-discussion-comments-legacy", "previews": [], "headers": [], "parameters": [ @@ -70987,7 +71632,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussions#list-discussions", "previews": [], "headers": [], "parameters": [ @@ -71092,8 +71737,8 @@ "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", + "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/teams/discussions#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/teams/discussions#list-discussions-legacy", "previews": [], "headers": [], "parameters": [ @@ -71173,7 +71818,7 @@ "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/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token.", - "documentationUrl": "https://docs.github.com/rest/reference/teams#list-teams-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -71230,7 +71875,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/members#list-team-members", "previews": [], "headers": [], "parameters": [ @@ -71322,8 +71967,8 @@ "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", + "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/teams/members#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", + "documentationUrl": "https://docs.github.com/rest/teams/members#list-team-members-legacy", "previews": [], "headers": [], "parameters": [ @@ -71404,7 +72049,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/members#list-pending-team-invitations", "previews": [], "headers": [], "parameters": [ @@ -71483,8 +72128,8 @@ "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", + "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/teams/members#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/teams/members#list-pending-team-invitations-legacy", "previews": [], "headers": [], "parameters": [ @@ -71551,7 +72196,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-team-projects", "previews": [], "headers": [], "parameters": [ @@ -71630,8 +72275,8 @@ "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", + "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/teams/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy", "previews": [], "headers": [], "parameters": [ @@ -71699,7 +72344,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-team-repositories", "previews": [], "headers": [], "parameters": [ @@ -71778,8 +72423,8 @@ "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", + "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/teams/teams#list-team-repositories) endpoint.", + "documentationUrl": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy", "previews": [], "headers": [], "parameters": [ @@ -71846,8 +72491,8 @@ "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://docs.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://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-member-legacy", + "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/teams/members#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://docs.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://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "documentationUrl": "https://docs.github.com/rest/teams/members#remove-team-member-legacy", "previews": [], "headers": [], "parameters": [ @@ -71898,7 +72543,7 @@ "deprecationDate": null, "removalDate": null, "description": "To 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\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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://docs.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", + "documentationUrl": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -71961,8 +72606,8 @@ "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://docs.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://docs.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", + "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/teams/members#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://docs.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://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "documentationUrl": "https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy", "previews": [], "headers": [], "parameters": [ @@ -72013,7 +72658,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team", "previews": [], "headers": [], "parameters": [ @@ -72069,8 +72714,8 @@ "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", + "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/teams/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/teams/teams#remove-a-project-from-a-team-legacy", "previews": [], "headers": [], "parameters": [ @@ -72122,7 +72767,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team", "previews": [], "headers": [], "parameters": [ @@ -72191,8 +72836,8 @@ "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", + "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/teams/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/teams/teams#remove-a-repository-from-a-team-legacy", "previews": [], "headers": [], "parameters": [ @@ -72249,7 +72894,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment", "previews": [], "headers": [], "parameters": [ @@ -72341,8 +72986,8 @@ "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", + "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/teams/discussion-comments#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/teams/discussion-comments#update-a-discussion-comment-legacy", "previews": [], "headers": [], "parameters": [ @@ -72422,7 +73067,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/discussions#update-a-discussion", "previews": [], "headers": [], "parameters": [ @@ -72514,8 +73159,8 @@ "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", + "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/teams/discussions#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/teams/discussions#update-a-discussion-legacy", "previews": [], "headers": [], "parameters": [ @@ -72595,7 +73240,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/teams/teams#update-a-team", "previews": [], "headers": [], "parameters": [ @@ -72742,8 +73387,8 @@ "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", + "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/teams/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/teams/teams#update-a-team-legacy", "previews": [], "headers": [], "parameters": [ @@ -72878,7 +73523,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -72937,7 +73582,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#add-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -72991,7 +73636,7 @@ "deprecationDate": null, "removalDate": null, "description": "Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/rest/users/social-accounts#add-social-account-for-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/social-accounts#add-social-accounts-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73044,8 +73689,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/users#block-a-user", + "description": "Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned.", + "documentationUrl": "https://docs.github.com/rest/users/blocking#block-a-user", "previews": [], "headers": [], "parameters": [ @@ -73090,8 +73735,8 @@ "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", + "description": "Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub.", + "documentationUrl": "https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73140,7 +73785,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/users#check-if-a-user-follows-another-user", + "documentationUrl": "https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user", "previews": [], "headers": [], "parameters": [ @@ -73195,7 +73840,7 @@ "deprecationDate": null, "removalDate": null, "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73244,7 +73889,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73316,7 +73961,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#create-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73383,7 +74028,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73461,7 +74106,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#create-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73528,7 +74173,7 @@ "deprecationDate": null, "removalDate": null, "description": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", - "documentationUrl": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73595,7 +74240,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73646,7 +74291,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#delete-an-email-address-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73692,7 +74337,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73743,7 +74388,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73789,7 +74434,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73841,7 +74486,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73882,7 +74527,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/rest/users/social-accounts#delete-social-account-for-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73928,7 +74573,7 @@ "deprecationDate": null, "removalDate": null, "description": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", - "documentationUrl": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -73969,7 +74614,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#follow-a-user", "previews": [], "headers": [], "parameters": [ @@ -74010,7 +74655,7 @@ "deprecationDate": null, "removalDate": null, "description": "If the authenticated user is authenticated with an OAuth token 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", + "documentationUrl": "https://docs.github.com/rest/users/users#get-the-authenticated-user", "previews": [], "headers": [], "parameters": [], @@ -74046,8 +74691,8 @@ "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", + "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/users/emails)\".", + "documentationUrl": "https://docs.github.com/rest/users/users#get-a-user", "previews": [], "headers": [], "parameters": [ @@ -74092,7 +74737,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/users#get-contextual-information-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -74165,7 +74810,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74219,7 +74864,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74268,7 +74913,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74325,7 +74970,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74374,7 +75019,7 @@ "deprecationDate": null, "removalDate": null, "description": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", - "documentationUrl": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74423,7 +75068,7 @@ "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/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users.", - "documentationUrl": "https://docs.github.com/rest/reference/users#list-users", + "documentationUrl": "https://docs.github.com/rest/users/users#list-users", "previews": [], "headers": [], "parameters": [ @@ -74478,7 +75123,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74545,7 +75190,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/blocking#list-users-blocked-by-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74607,7 +75252,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74674,7 +75319,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#list-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74736,7 +75381,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows", "previews": [], "headers": [], "parameters": [ @@ -74802,7 +75447,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#list-the-people-the-authenticated-user-follows", "previews": [], "headers": [], "parameters": [ @@ -74863,7 +75508,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#list-followers-of-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -74924,7 +75569,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#list-followers-of-a-user", "previews": [], "headers": [], "parameters": [ @@ -74991,7 +75636,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#list-the-people-a-user-follows", "previews": [], "headers": [], "parameters": [ @@ -75058,7 +75703,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75125,7 +75770,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75187,7 +75832,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -75253,8 +75898,8 @@ "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", + "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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", + "documentationUrl": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75323,8 +75968,8 @@ "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", + "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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", + "documentationUrl": "https://docs.github.com/rest/users/emails#list-public-email-addresses-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75386,7 +76031,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#list-public-keys-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -75449,7 +76094,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75519,7 +76164,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75710,7 +76355,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", - "documentationUrl": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user", + "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75772,7 +76417,7 @@ "deprecationDate": null, "removalDate": null, "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", - "documentationUrl": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user", + "documentationUrl": "https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user", "previews": [], "headers": [], "parameters": [ @@ -75839,7 +76484,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75904,7 +76549,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user", "previews": [], "headers": [], "parameters": [ @@ -75957,8 +76602,8 @@ "isDeprecated": false, "deprecationDate": null, "removalDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/rest/reference/users#unblock-a-user", + "description": "Unblocks the given user and returns a 204.", + "documentationUrl": "https://docs.github.com/rest/users/blocking#unblock-a-user", "previews": [], "headers": [], "parameters": [ @@ -75999,7 +76644,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/followers#unfollow-a-user", "previews": [], "headers": [], "parameters": [ @@ -76040,7 +76685,7 @@ "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", + "documentationUrl": "https://docs.github.com/rest/users/users#update-the-authenticated-user", "previews": [], "headers": [], "parameters": [ diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index d312ea75c..dd0b2fda2 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -13,9 +13,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addSelectedRepoToOrgVariable: [ "PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}", ], - addSelectedRepoToRequiredWorkflow: [ - "PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}", - ], approveWorkflowRun: [ "POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve", ], @@ -44,7 +41,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "POST /repos/{owner}/{repo}/actions/runners/remove-token", ], createRepoVariable: ["POST /repos/{owner}/{repo}/actions/variables"], - createRequiredWorkflow: ["POST /orgs/{org}/actions/required_workflows"], createWorkflowDispatch: [ "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", ], @@ -71,9 +67,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { deleteRepoVariable: [ "DELETE /repos/{owner}/{repo}/actions/variables/{name}", ], - deleteRequiredWorkflow: [ - "DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}", - ], deleteSelfHostedRunnerFromOrg: [ "DELETE /orgs/{org}/actions/runners/{runner_id}", ], @@ -161,17 +154,8 @@ const Endpoints: EndpointsDefaultsAndDecorations = { { renamed: ["actions", "getGithubActionsPermissionsRepository"] }, ], getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], - getRepoRequiredWorkflow: [ - "GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}", - ], - getRepoRequiredWorkflowUsage: [ - "GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing", - ], getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], getRepoVariable: ["GET /repos/{owner}/{repo}/actions/variables/{name}"], - getRequiredWorkflow: [ - "GET /orgs/{org}/actions/required_workflows/{required_workflow_id}", - ], getReviewsForRun: [ "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals", ], @@ -220,16 +204,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listRepoOrganizationVariables: [ "GET /repos/{owner}/{repo}/actions/organization-variables", ], - listRepoRequiredWorkflows: [ - "GET /repos/{org}/{repo}/actions/required_workflows", - ], listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], listRepoVariables: ["GET /repos/{owner}/{repo}/actions/variables"], listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], - listRequiredWorkflowRuns: [ - "GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs", - ], - listRequiredWorkflows: ["GET /orgs/{org}/actions/required_workflows"], listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], listRunnerApplicationsForRepo: [ "GET /repos/{owner}/{repo}/actions/runners/downloads", @@ -243,9 +220,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listSelectedRepositoriesEnabledGithubActionsOrganization: [ "GET /orgs/{org}/actions/permissions/repositories", ], - listSelectedRepositoriesRequiredWorkflow: [ - "GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories", - ], listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], listWorkflowRunArtifacts: [ @@ -280,9 +254,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { removeSelectedRepoFromOrgVariable: [ "DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}", ], - removeSelectedRepoFromRequiredWorkflow: [ - "DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}", - ], reviewCustomGatesForRun: [ "POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule", ], @@ -319,9 +290,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { setSelectedReposForOrgVariable: [ "PUT /orgs/{org}/actions/variables/{name}/repositories", ], - setSelectedReposToRequiredWorkflow: [ - "PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories", - ], setSelectedRepositoriesEnabledGithubActionsOrganization: [ "PUT /orgs/{org}/actions/permissions/repositories", ], @@ -335,9 +303,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { updateRepoVariable: [ "PATCH /repos/{owner}/{repo}/actions/variables/{name}", ], - updateRequiredWorkflow: [ - "PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}", - ], }, activity: { checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], @@ -564,9 +529,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { createWithRepoForAuthenticatedUser: [ "POST /repos/{owner}/{repo}/codespaces", ], - deleteCodespacesBillingUsers: [ - "DELETE /orgs/{org}/codespaces/billing/selected_users", - ], deleteForAuthenticatedUser: ["DELETE /user/codespaces/{codespace_name}"], deleteFromOrganization: [ "DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}", @@ -638,10 +600,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { repoMachinesForAuthenticatedUser: [ "GET /repos/{owner}/{repo}/codespaces/machines", ], - setCodespacesBilling: ["PUT /orgs/{org}/codespaces/billing"], - setCodespacesBillingUsers: [ - "POST /orgs/{org}/codespaces/billing/selected_users", - ], setRepositoriesForSecretForAuthenticatedUser: [ "PUT /user/codespaces/secrets/{secret_name}/repositories", ], @@ -655,6 +613,25 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], updateForAuthenticatedUser: ["PATCH /user/codespaces/{codespace_name}"], }, + copilot: { + addCopilotForBusinessSeatsForTeams: [ + "POST /orgs/{org}/copilot/billing/selected_teams", + ], + addCopilotForBusinessSeatsForUsers: [ + "POST /orgs/{org}/copilot/billing/selected_users", + ], + cancelCopilotSeatAssignmentForTeams: [ + "DELETE /orgs/{org}/copilot/billing/selected_teams", + ], + cancelCopilotSeatAssignmentForUsers: [ + "DELETE /orgs/{org}/copilot/billing/selected_users", + ], + getCopilotOrganizationDetails: ["GET /orgs/{org}/copilot/billing"], + getCopilotSeatAssignmentDetailsForUser: [ + "GET /orgs/{org}/members/{username}/copilot", + ], + listCopilotSeats: ["GET /orgs/{org}/copilot/billing/seats"], + }, dependabot: { addSelectedRepoToOrgSecret: [ "PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}", @@ -943,15 +920,13 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], listPatGrantRepositories: [ - "GET /organizations/{org}/personal-access-tokens/{pat_id}/repositories", + "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories", ], listPatGrantRequestRepositories: [ - "GET /organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories", + "GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories", ], - listPatGrantRequests: [ - "GET /organizations/{org}/personal-access-token-requests", - ], - listPatGrants: ["GET /organizations/{org}/personal-access-tokens"], + listPatGrantRequests: ["GET /orgs/{org}/personal-access-token-requests"], + listPatGrants: ["GET /orgs/{org}/personal-access-tokens"], listPendingInvitations: ["GET /orgs/{org}/invitations"], listPublicMembers: ["GET /orgs/{org}/public_members"], listSecurityManagerTeams: ["GET /orgs/{org}/security-managers"], @@ -973,10 +948,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "DELETE /orgs/{org}/security-managers/teams/{team_slug}", ], reviewPatGrantRequest: [ - "POST /organizations/{org}/personal-access-token-requests/{pat_request_id}", + "POST /orgs/{org}/personal-access-token-requests/{pat_request_id}", ], reviewPatGrantRequestsInBulk: [ - "POST /organizations/{org}/personal-access-token-requests", + "POST /orgs/{org}/personal-access-token-requests", ], setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], setPublicMembershipForAuthenticatedUser: [ @@ -987,10 +962,8 @@ const Endpoints: EndpointsDefaultsAndDecorations = { updateMembershipForAuthenticatedUser: [ "PATCH /user/memberships/orgs/{org}", ], - updatePatAccess: [ - "POST /organizations/{org}/personal-access-tokens/{pat_id}", - ], - updatePatAccesses: ["POST /organizations/{org}/personal-access-tokens"], + updatePatAccess: ["POST /orgs/{org}/personal-access-tokens/{pat_id}"], + updatePatAccesses: ["POST /orgs/{org}/personal-access-tokens"], updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], }, @@ -1270,6 +1243,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { mapToData: "users" }, ], + checkAutomatedSecurityFixes: [ + "GET /repos/{owner}/{repo}/automated-security-fixes", + ], checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], checkVulnerabilityAlerts: [ "GET /repos/{owner}/{repo}/vulnerability-alerts", @@ -1373,7 +1349,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { disableDeploymentProtectionRule: [ "DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", ], - disableLfsForRepo: ["DELETE /repos/{owner}/{repo}/lfs"], + disablePrivateVulnerabilityReporting: [ + "DELETE /repos/{owner}/{repo}/private-vulnerability-reporting", + ], disableVulnerabilityAlerts: [ "DELETE /repos/{owner}/{repo}/vulnerability-alerts", ], @@ -1387,7 +1365,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { enableAutomatedSecurityFixes: [ "PUT /repos/{owner}/{repo}/automated-security-fixes", ], - enableLfsForRepo: ["PUT /repos/{owner}/{repo}/lfs"], + enablePrivateVulnerabilityReporting: [ + "PUT /repos/{owner}/{repo}/private-vulnerability-reporting", + ], enableVulnerabilityAlerts: [ "PUT /repos/{owner}/{repo}/vulnerability-alerts", ], @@ -1485,6 +1465,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { getWebhookDelivery: [ "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", ], + listActivities: ["GET /repos/{owner}/{repo}/activity"], listAutolinks: ["GET /repos/{owner}/{repo}/autolinks"], listBranches: ["GET /repos/{owner}/{repo}/branches"], listBranchesForHeadCommit: [ @@ -1664,9 +1645,15 @@ const Endpoints: EndpointsDefaultsAndDecorations = { createRepositoryAdvisory: [ "POST /repos/{owner}/{repo}/security-advisories", ], + createRepositoryAdvisoryCveRequest: [ + "POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve", + ], + getGlobalAdvisory: ["GET /advisories/{ghsa_id}"], getRepositoryAdvisory: [ "GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}", ], + listGlobalAdvisories: ["GET /advisories"], + listOrgRepositoryAdvisories: ["GET /orgs/{org}/security-advisories"], listRepositoryAdvisories: ["GET /repos/{owner}/{repo}/security-advisories"], updateRepositoryAdvisory: [ "PATCH /repos/{owner}/{repo}/security-advisories/{ghsa_id}", diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 5bfd646db..7ee54f07b 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -7,6 +7,9 @@ export type RestEndpointMethods = { * Add custom labels to a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ addCustomLabelsToSelfHostedRunnerForOrg: { ( @@ -20,8 +23,10 @@ export type RestEndpointMethods = { /** * Add custom labels to a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ addCustomLabelsToSelfHostedRunnerForRepo: { ( @@ -33,7 +38,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ addSelectedRepoToOrgSecret: { ( @@ -45,7 +57,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Adds a repository to an organization variable that is available to selected repositories. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ addSelectedRepoToOrgVariable: { ( @@ -56,22 +74,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - addSelectedRepoToRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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)." * @@ -87,7 +89,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Cancels a workflow run using its `id`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions:write` permission to use this endpoint. */ cancelWorkflowRun: { ( @@ -100,8 +106,11 @@ export type RestEndpointMethods = { }; /** * Create an environment variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ createEnvironmentVariable: { ( @@ -114,81 +123,11 @@ export type RestEndpointMethods = { }; /** * Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ createOrUpdateEnvironmentSecret: { ( @@ -287,81 +226,11 @@ export type RestEndpointMethods = { }; /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). 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. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ createOrUpdateRepoSecret: { ( @@ -374,8 +243,11 @@ export type RestEndpointMethods = { }; /** * Creates an organization variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ createOrgVariable: { ( @@ -390,8 +262,11 @@ export type RestEndpointMethods = { * Returns a token that you can pass to the `config` script. The token expires after one hour. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * #### Example using registration token + * Example using registration token: * * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * @@ -409,16 +284,20 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate - * using an access token with the `repo` scope to use this endpoint. + * Returns a token that you can pass to the `config` script. The token + * expires after one hour. * - * #### Example using registration token + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Example using registration token: * - * ``` - * ./config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN - * ``` + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided + * by this endpoint. + * + * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` */ createRegistrationTokenForRepo: { ( @@ -433,8 +312,11 @@ export type RestEndpointMethods = { * 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. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * #### Example using remove token + * Example using remove token: * * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this * endpoint. @@ -453,16 +335,20 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. + * Returns a token that you can pass to remove a self-hosted runner from + * a repository. The token expires after one hour. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * #### Example using remove token + * Example using remove token: * - * To remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint. + * To remove your self-hosted runner from a repository, replace TOKEN with + * the remove token provided by this endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ```config.sh remove --token TOKEN``` */ createRemoveTokenForRepo: { ( @@ -475,8 +361,11 @@ export type RestEndpointMethods = { }; /** * Creates a repository variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ createRepoVariable: { ( @@ -487,22 +376,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Create a required workflow in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - createRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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`. * @@ -564,7 +437,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ deleteEnvironmentSecret: { ( @@ -577,8 +454,11 @@ export type RestEndpointMethods = { }; /** * Deletes an environment variable using the variable name. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ deleteEnvironmentVariable: { ( @@ -590,7 +470,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ deleteOrgSecret: { ( @@ -603,8 +488,11 @@ export type RestEndpointMethods = { }; /** * Deletes an organization variable using the variable name. + * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ deleteOrgVariable: { ( @@ -616,7 +504,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ deleteRepoSecret: { ( @@ -629,8 +521,11 @@ export type RestEndpointMethods = { }; /** * Deletes a repository variable using the variable name. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ deleteRepoVariable: { ( @@ -641,26 +536,13 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Deletes a required workflow configured in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - deleteRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ deleteSelfHostedRunnerFromOrg: { ( @@ -674,8 +556,10 @@ export type RestEndpointMethods = { /** * 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. * - * You must authenticate using an access token with the `repo` - * scope to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ deleteSelfHostedRunnerFromRepo: { ( @@ -742,8 +626,9 @@ export type RestEndpointMethods = { }; /** * Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. 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. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. * GitHub Apps must have the `actions:read` permission to use this endpoint. */ downloadArtifact: { @@ -832,6 +717,9 @@ export type RestEndpointMethods = { * Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ generateRunnerJitconfigForOrg: { ( @@ -846,6 +734,9 @@ export type RestEndpointMethods = { * Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ generateRunnerJitconfigForRepo: { ( @@ -951,7 +842,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getEnvironmentPublicKey: { ( @@ -963,7 +860,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getEnvironmentSecret: { ( @@ -975,7 +876,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Gets a specific variable in an environment. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ getEnvironmentVariable: { ( @@ -1059,7 +965,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getOrgPublicKey: { ( @@ -1071,7 +983,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getOrgSecret: { ( @@ -1083,7 +1000,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Gets a specific variable in an organization. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ getOrgVariable: { ( @@ -1124,7 +1046,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getRepoPublicKey: { ( @@ -1136,35 +1064,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific required workflow present 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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - getRepoRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * Gets the number of billable minutes used by a specific required workflow during the current billing cycle. + * Gets a single repository secret without revealing its encrypted value. * - * Billable minutes only apply to required workflows running 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://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)." - * - * 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. - */ - getRepoRequiredWorkflowUsage: { - ( - params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ getRepoSecret: { ( @@ -1176,7 +1080,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Gets a specific variable in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ getRepoVariable: { ( @@ -1187,22 +1096,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Get a required workflow configured in an organization. - * - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - getRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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. */ @@ -1219,6 +1112,9 @@ export type RestEndpointMethods = { * Gets a specific self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ getSelfHostedRunnerForOrg: { ( @@ -1232,8 +1128,10 @@ export type RestEndpointMethods = { /** * Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ getSelfHostedRunnerForRepo: { ( @@ -1339,7 +1237,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ listEnvironmentSecrets: { ( @@ -1351,7 +1254,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Lists all environment variables. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `environments:read` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ listEnvironmentVariables: { ( @@ -1390,6 +1298,9 @@ export type RestEndpointMethods = { * Lists all labels for a self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listLabelsForSelfHostedRunnerForOrg: { ( @@ -1403,8 +1314,10 @@ export type RestEndpointMethods = { /** * Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listLabelsForSelfHostedRunnerForRepo: { ( @@ -1416,7 +1329,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ listOrgSecrets: { ( @@ -1428,7 +1347,8 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Lists all organization variables. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. */ listOrgVariables: { ( @@ -1440,7 +1360,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all organization secrets shared with 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. + * Lists all organization secrets shared with 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ listRepoOrganizationSecrets: { ( @@ -1452,7 +1377,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all organiation variables shared with a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Lists all organiation variables shared with a repository. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ listRepoOrganizationVariables: { ( @@ -1464,19 +1394,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists the required 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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - listRepoRequiredWorkflows: { - ( - params?: RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * 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. + * 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. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ listRepoSecrets: { ( @@ -1488,7 +1411,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Lists all repository variables. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ listRepoVariables: { ( @@ -1500,43 +1427,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. - */ - listRepoWorkflows: { - ( - params?: RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * List all workflow runs for a required workflow. 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). - * - * 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. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - listRequiredWorkflowRuns: { - ( - params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * List all required workflows in an organization. - * - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." + * 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. */ - listRequiredWorkflows: { + listRepoWorkflows: { ( - params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["parameters"], + params?: RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["parameters"], ): Promise< - RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["response"] + RestEndpointMethodTypes["actions"]["listRepoWorkflows"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -1545,6 +1442,9 @@ export type RestEndpointMethods = { * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listRunnerApplicationsForOrg: { ( @@ -1559,6 +1459,9 @@ export type RestEndpointMethods = { * Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listRunnerApplicationsForRepo: { ( @@ -1570,7 +1473,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ listSelectedReposForOrgSecret: { ( @@ -1582,7 +1491,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Lists all repositories that can access an organization variable + * that is available to selected repositories. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ listSelectedReposForOrgVariable: { ( @@ -1607,26 +1522,13 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories. - * - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - listSelectedRepositoriesRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Lists all self-hosted runners configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listSelfHostedRunnersForOrg: { ( @@ -1638,7 +1540,12 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. + * Lists all self-hosted runners configured in a repository. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ listSelfHostedRunnersForRepo: { ( @@ -1690,7 +1597,11 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Re-run a job and its dependent jobs in 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. + * Re-run a job and its dependent jobs in a workflow run. + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `actions:write` permission to use this endpoint. */ reRunJobForWorkflowRun: { ( @@ -1730,6 +1641,9 @@ export type RestEndpointMethods = { * organization. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ removeAllCustomLabelsFromSelfHostedRunnerForOrg: { ( @@ -1744,8 +1658,10 @@ export type RestEndpointMethods = { * Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ removeAllCustomLabelsFromSelfHostedRunnerForRepo: { ( @@ -1764,6 +1680,9 @@ export type RestEndpointMethods = { * present on the runner. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ removeCustomLabelFromSelfHostedRunnerForOrg: { ( @@ -1781,8 +1700,10 @@ export type RestEndpointMethods = { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ removeCustomLabelFromSelfHostedRunnerForRepo: { ( @@ -1794,7 +1715,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ removeSelectedRepoFromOrgSecret: { ( @@ -1806,7 +1734,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Removes a repository from an organization variable that is + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ removeSelectedRepoFromOrgVariable: { ( @@ -1817,28 +1752,13 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - removeSelectedRepoFromRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. */ reviewCustomGatesForRun: { @@ -1897,6 +1817,9 @@ export type RestEndpointMethods = { * self-hosted runner configured in an organization. * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ setCustomLabelsForSelfHostedRunnerForOrg: { ( @@ -1911,8 +1834,10 @@ export type RestEndpointMethods = { * Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ setCustomLabelsForSelfHostedRunnerForRepo: { ( @@ -1984,7 +1909,14 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/actions/secrets#create-or-update-an-organization-secret). + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ setSelectedReposForOrgSecret: { ( @@ -1996,7 +1928,15 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Replaces all repositories for an organization variable that is available + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. + * + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this + * endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ setSelectedReposForOrgVariable: { ( @@ -2007,22 +1947,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Sets the repositories for a required workflow that is required for selected repositories. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - setSelectedReposToRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * 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)." * @@ -2056,8 +1980,11 @@ export type RestEndpointMethods = { }; /** * Updates an environment variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ updateEnvironmentVariable: { ( @@ -2070,8 +1997,11 @@ export type RestEndpointMethods = { }; /** * Updates an organization variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ updateOrgVariable: { ( @@ -2084,8 +2014,11 @@ export type RestEndpointMethods = { }; /** * Updates a repository variable that you can reference in a GitHub Actions workflow. + * * You must authenticate using an access token with the `repo` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ updateRepoVariable: { ( @@ -2096,24 +2029,11 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Update a required workflow in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * - * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." - */ - updateRequiredWorkflow: { - ( - params?: RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["parameters"], - ): Promise< - RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; }; activity: { + /** + * Whether the authenticated user has starred the repository. + */ checkRepoIsStarredByAuthenticatedUser: { ( params?: RestEndpointMethodTypes["activity"]["checkRepoIsStarredByAuthenticatedUser"]["parameters"], @@ -2124,7 +2044,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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). + * 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/activity/watching#set-a-repository-subscription). */ deleteRepoSubscription: { ( @@ -2136,7 +2056,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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`. + * 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/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ deleteThreadSubscription: { ( @@ -2167,7 +2087,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Gets information about whether the authenticated user is subscribed to the repository. + */ getRepoSubscription: { ( params?: RestEndpointMethodTypes["activity"]["getRepoSubscription"]["parameters"], @@ -2188,7 +2110,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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). + * 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/activity/watching#get-a-repository-subscription). * * Note 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. */ @@ -2404,7 +2326,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Marks all notifications as "read" for the current user. 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`. + * Marks all notifications as "read" for the current user. 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/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ markNotificationsAsRead: { ( @@ -2416,7 +2338,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Marks all notifications in a repository as "read" for the current user. 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`. + * Marks all notifications in a repository as "read" for the current user. 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/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ markRepoNotificationsAsRead: { ( @@ -2440,7 +2362,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/activity/watching#delete-a-repository-subscription) completely. */ setRepoSubscription: { ( @@ -2456,7 +2378,7 @@ export type RestEndpointMethods = { * * You 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. * - * Unsubscribing 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. + * Unsubscribing 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/activity/notifications#delete-a-thread-subscription) endpoint. */ setThreadSubscription: { ( @@ -2479,7 +2401,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Unstar a repository that the authenticated user has previously starred. + */ unstarRepoForAuthenticatedUser: { ( params?: RestEndpointMethodTypes["activity"]["unstarRepoForAuthenticatedUser"]["parameters"], @@ -2570,7 +2494,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/apps/apps#suspend-an-app-installation)" endpoint. * * 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. */ @@ -2594,7 +2518,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * * 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. */ @@ -2664,7 +2588,7 @@ export type RestEndpointMethods = { /** * 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. * - * GitHub 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. + * GitHub 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. */ getSubscriptionPlanForAccount: { ( @@ -2678,7 +2602,7 @@ export type RestEndpointMethods = { /** * 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. * - * GitHub 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. + * GitHub 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. */ getSubscriptionPlanForAccountStubbed: { ( @@ -2734,7 +2658,7 @@ export type RestEndpointMethods = { /** * 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. * - * GitHub 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. + * GitHub 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. */ listAccountsForPlan: { ( @@ -2748,7 +2672,7 @@ export type RestEndpointMethods = { /** * 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. * - * GitHub 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. + * GitHub 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. */ listAccountsForPlanStubbed: { ( @@ -2764,7 +2688,7 @@ export type RestEndpointMethods = { * * The 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. * - * 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. + * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. * * The access the user has to each repository is included in the hash under the `permissions` key. */ @@ -2790,7 +2714,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * * The permissions the installation has are included under the `permissions` key. */ @@ -2806,7 +2730,7 @@ export type RestEndpointMethods = { /** * Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * 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. + * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. * * The 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. * @@ -2824,7 +2748,7 @@ export type RestEndpointMethods = { /** * Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub 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. + * GitHub 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. */ listPlans: { ( @@ -2836,7 +2760,7 @@ export type RestEndpointMethods = { /** * Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub 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. + * GitHub 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. */ listPlansStubbed: { ( @@ -2862,7 +2786,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/). + * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ listSubscriptionsForAuthenticatedUser: { ( @@ -2874,7 +2798,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/). + * Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), 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/oauth-apps/building-oauth-apps/authorizing-oauth-apps). */ listSubscriptionsForAuthenticatedUserStubbed: { ( @@ -2955,7 +2879,7 @@ export type RestEndpointMethods = { /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once 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. + * Once 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/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * * You 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. */ @@ -2969,7 +2893,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Use a non-scoped user-to-server access token to create a repository scoped and/or permission scoped user-to-server 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * Use a non-scoped user access token to create a repository scoped and/or permission scoped user 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 `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. */ scopeToken: { ( @@ -3137,7 +3061,7 @@ export type RestEndpointMethods = { /** * **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`. * - * By 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. + * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/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/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. */ createSuite: { ( @@ -3149,7 +3073,7 @@ export type RestEndpointMethods = { /** * **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. * - * Gets 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. + * Gets 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. */ get: { ( @@ -3161,7 +3085,7 @@ export type RestEndpointMethods = { /** * **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`. * - * Gets 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. + * Gets 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. */ getSuite: { ( @@ -3171,7 +3095,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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. */ listAnnotations: { ( @@ -3185,7 +3109,7 @@ export type RestEndpointMethods = { /** * **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. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ listForRef: { ( @@ -3197,7 +3121,7 @@ export type RestEndpointMethods = { /** * **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. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. */ listForSuite: { ( @@ -3209,7 +3133,7 @@ export type RestEndpointMethods = { /** * **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`. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. */ listSuitesForRef: { ( @@ -3224,6 +3148,8 @@ export type RestEndpointMethods = { * Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + * + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". */ rerequestRun: { ( @@ -3235,7 +3161,7 @@ export type RestEndpointMethods = { /** * 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. * - * To rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. + * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. */ rerequestSuite: { ( @@ -3247,7 +3173,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. */ setSuitesPreferences: { ( @@ -3427,7 +3353,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * 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/code-scanning/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 with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. */ getSarif: { ( @@ -3579,7 +3505,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * 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 for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - 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)." @@ -3592,7 +3518,7 @@ export type RestEndpointMethods = { * ``` *
* SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. - * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. + * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * * | **SARIF data** | **Maximum values** | **Additional limits** | @@ -3608,7 +3534,7 @@ export type RestEndpointMethods = { * * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. - * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." */ uploadSarif: { ( @@ -3621,6 +3547,9 @@ export type RestEndpointMethods = { }; }; codesOfConduct: { + /** + * Returns array of all GitHub's codes of conduct. + */ getAllCodesOfConduct: { ( params?: RestEndpointMethodTypes["codesOfConduct"]["getAllCodesOfConduct"]["parameters"], @@ -3630,7 +3559,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Returns information about the specified GitHub code of conduct. + */ getConductCode: { ( params?: RestEndpointMethodTypes["codesOfConduct"]["getConductCode"]["parameters"], @@ -3657,7 +3588,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * 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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ addSelectedRepoToOrgSecret: { ( @@ -3704,80 +3635,10 @@ export type RestEndpointMethods = { }; /** * Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * **Example encrypting a secret using Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. */ createOrUpdateOrgSecret: { ( @@ -3790,170 +3651,28 @@ export type RestEndpointMethods = { }; /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * You must authenticate using an access * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` * repository permission to use this endpoint. - * - * #### Example of encrypting a secret using Node.js - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * #### Example of encrypting a secret using Python - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example of encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example of encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` */ createOrUpdateRepoSecret: { ( params?: RestEndpointMethodTypes["codespaces"]["createOrUpdateRepoSecret"]["parameters"], ): Promise< RestEndpointMethodTypes["codespaces"]["createOrUpdateRepoSecret"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). - * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. */ createOrUpdateSecretForAuthenticatedUser: { ( @@ -3996,19 +3715,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Codespaces for the specified users will no longer be billed to the organization. - * To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ - deleteCodespacesBillingUsers: { - ( - params?: RestEndpointMethodTypes["codespaces"]["deleteCodespacesBillingUsers"]["parameters"], - ): Promise< - RestEndpointMethodTypes["codespaces"]["deleteCodespacesBillingUsers"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Deletes a user's codespace. * @@ -4408,7 +4114,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * 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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ removeSelectedRepoFromOrgSecret: { ( @@ -4435,32 +4141,6 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - /** - * Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ - setCodespacesBilling: { - ( - params?: RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["parameters"], - ): Promise< - RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; - /** - * Codespaces for the specified users will be billed to the organization. - * To use this endpoint, the billing settings for the organization must be set to `selected_members`. For information on how to change this setting please see [these docs].(https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces) You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ - setCodespacesBillingUsers: { - ( - params?: RestEndpointMethodTypes["codespaces"]["setCodespacesBillingUsers"]["parameters"], - ): Promise< - RestEndpointMethodTypes["codespaces"]["setCodespacesBillingUsers"]["response"] - >; - defaults: RequestInterface["defaults"]; - endpoint: EndpointInterface<{ url: string }>; - }; /** * Select the repositories that will use a user's codespace secret. * @@ -4478,7 +4158,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/codespaces#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * 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/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ setSelectedReposForOrgSecret: { ( @@ -4554,9 +4234,151 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; }; + copilot: { + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Purchases a GitHub Copilot for Business seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * + * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * + * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + */ + addCopilotForBusinessSeatsForTeams: { + ( + params?: RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForTeams"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForTeams"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Purchases a GitHub Copilot for Business seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * + * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * + * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + */ + addCopilotForBusinessSeatsForUsers: { + ( + params?: RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForUsers"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["addCopilotForBusinessSeatsForUsers"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Cancels the Copilot for Business seat assignment for all members of each team specified. + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * + * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * + * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * + * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + */ + cancelCopilotSeatAssignmentForTeams: { + ( + params?: RestEndpointMethodTypes["copilot"]["cancelCopilotSeatAssignmentForTeams"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["cancelCopilotSeatAssignmentForTeams"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Cancels the Copilot for Business seat assignment for each user specified. + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * + * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * + * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * + * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + */ + cancelCopilotSeatAssignmentForUsers: { + ( + params?: RestEndpointMethodTypes["copilot"]["cancelCopilotSeatAssignmentForUsers"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["cancelCopilotSeatAssignmentForUsers"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + */ + getCopilotOrganizationDetails: { + ( + params?: RestEndpointMethodTypes["copilot"]["getCopilotOrganizationDetails"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["getCopilotOrganizationDetails"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + */ + getCopilotSeatAssignmentDetailsForUser: { + ( + params?: RestEndpointMethodTypes["copilot"]["getCopilotSeatAssignmentDetailsForUser"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["getCopilotSeatAssignmentDetailsForUser"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * **Note**: This endpoint is in beta and is subject to change. + * + * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + */ + listCopilotSeats: { + ( + params?: RestEndpointMethodTypes["copilot"]["listCopilotSeats"]["parameters"], + ): Promise< + RestEndpointMethodTypes["copilot"]["listCopilotSeats"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + }; dependabot: { /** - * 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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. + * 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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. */ addSelectedRepoToOrgSecret: { ( @@ -4655,81 +4477,11 @@ export type RestEndpointMethods = { }; /** * Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * + * You must authenticate using an access * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository * permission to use this endpoint. - * - * **Example encrypting a secret using Node.js** - * - * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library. - * - * ``` - * const sodium = require('libsodium-wrappers') - * const secret = 'plain-text-secret' // replace with the secret you want to encrypt - * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key - * - * //Check if libsodium is ready and then proceed. - * sodium.ready.then(() => { - * // Convert Secret & Base64 key to Uint8Array. - * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL) - * let binsec = sodium.from_string(secret) - * - * //Encrypt the secret using LibSodium - * let encBytes = sodium.crypto_box_seal(binsec, binkey) - * - * // Convert encrypted Uint8Array to Base64 - * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) - * - * console.log(output) - * }); - * ``` - * - * **Example encrypting a secret using Python** - * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * **Example encrypting a secret using C#** - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * **Example encrypting a secret using Ruby** - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` */ createOrUpdateRepoSecret: { ( @@ -4908,7 +4660,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. + * 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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. */ removeSelectedRepoFromOrgSecret: { ( @@ -4920,7 +4672,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/dependabot#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 `dependabot_secrets` organization permission to use this endpoint. + * 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/dependabot/secrets#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 `dependabot_secrets` organization permission to use this endpoint. */ setSelectedReposForOrgSecret: { ( @@ -5188,7 +4940,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * * **Signature verification object** * @@ -5237,7 +4989,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/git/refs#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/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * * **Signature verification object** * @@ -5278,7 +5030,7 @@ export type RestEndpointMethods = { /** * 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. * - * If 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)." + * If 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/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." * * Returns an error if you try to delete a file that does not exist. */ @@ -5310,7 +5062,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects). + * Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). + * + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." * * **Signature verification object** * @@ -5351,7 +5105,7 @@ export type RestEndpointMethods = { /** * 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. * - * **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)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/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)". */ getRef: { ( @@ -5398,7 +5152,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns a single tree using the SHA1 value for that tree. + * Returns a single tree using the SHA1 value or ref name for that tree. * * If `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. * @@ -5417,7 +5171,7 @@ export type RestEndpointMethods = { * * When 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`. * - * **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)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/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)". * * If 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`. */ @@ -5441,7 +5195,7 @@ export type RestEndpointMethods = { }; gitignore: { /** - * 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). + * List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ getAllTemplates: { ( @@ -5765,7 +5519,7 @@ export type RestEndpointMethods = { * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `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 - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ get: { ( @@ -5823,7 +5577,7 @@ export type RestEndpointMethods = { * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `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 - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ list: { ( @@ -5910,7 +5664,7 @@ export type RestEndpointMethods = { * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `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 - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ listForAuthenticatedUser: { ( @@ -5927,7 +5681,7 @@ export type RestEndpointMethods = { * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `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 - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ listForOrg: { ( @@ -5942,7 +5696,7 @@ export type RestEndpointMethods = { * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `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 - * request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint. + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. */ listForRepo: { ( @@ -6109,6 +5863,9 @@ export type RestEndpointMethods = { }; }; licenses: { + /** + * Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + */ get: { ( params?: RestEndpointMethodTypes["licenses"]["get"]["parameters"], @@ -6116,7 +5873,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." + */ getAllCommonlyUsed: { ( params?: RestEndpointMethodTypes["licenses"]["getAllCommonlyUsed"]["parameters"], @@ -6129,7 +5888,7 @@ export type RestEndpointMethods = { /** * This method returns the contents of the repository's license file, if one is detected. * - * Similar 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. + * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#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. */ getForRepo: { ( @@ -6622,7 +6381,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. + */ blockUser: { ( params?: RestEndpointMethodTypes["orgs"]["blockUser"]["parameters"], @@ -6644,7 +6405,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. + */ checkBlockedUser: { ( params?: RestEndpointMethodTypes["orgs"]["checkBlockedUser"]["parameters"], @@ -6794,7 +6557,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." */ getWebhook: { ( @@ -6804,7 +6567,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/orgs/webhooks#get-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ @@ -6896,7 +6659,7 @@ export type RestEndpointMethods = { /** * List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This 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. + * This 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/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ listForUser: { ( @@ -7188,7 +6951,7 @@ export type RestEndpointMethods = { /** * Only authenticated organization owners can add a member to the organization or update the member's role. * - * * 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. + * * 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/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * * * 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. * @@ -7219,7 +6982,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Unblocks the given user on behalf of the specified organization. + */ unblockUser: { ( params?: RestEndpointMethodTypes["orgs"]["unblockUser"]["parameters"], @@ -7282,7 +7047,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." */ updateWebhook: { ( @@ -7292,7 +7057,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/orgs/webhooks#update-an-organization-webhook)." * * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ @@ -8065,9 +7830,9 @@ export type RestEndpointMethods = { /** * 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. * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **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 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. + * **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 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/pulls/pulls#get-a-pull-request) endpoint. * * 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. */ @@ -8079,7 +7844,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates 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. + * Creates 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/issues/comments#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. * * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * @@ -8121,7 +7886,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **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. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ dismissReview: { ( @@ -8135,7 +7900,7 @@ export type RestEndpointMethods = { * * Lists details of a pull request by providing its number. * - * When 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)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/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)". * * The 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. * @@ -8199,7 +7964,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/commits/commits#list-commits) endpoint. */ listCommits: { ( @@ -8300,7 +8065,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request)." + * Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." */ submitReview: { ( @@ -8358,6 +8123,17 @@ export type RestEndpointMethods = { /** * **Note:** Accessing this endpoint does not count against your REST API rate limit. * + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * * **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. */ get: { @@ -8370,7 +8146,7 @@ export type RestEndpointMethods = { }; reactions: { /** - * 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. + * Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ createForCommitComment: { ( @@ -8382,7 +8158,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ createForIssue: { ( @@ -8394,7 +8170,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ createForIssueComment: { ( @@ -8406,7 +8182,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ createForPullRequestReviewComment: { ( @@ -8418,7 +8194,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ createForRelease: { ( @@ -8430,7 +8206,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). 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. * * **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`. */ @@ -8444,7 +8220,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). 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. * * **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`. */ @@ -8460,7 +8236,7 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ deleteForCommitComment: { ( @@ -8474,7 +8250,7 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/reference/issues/). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ deleteForIssue: { ( @@ -8488,7 +8264,7 @@ export type RestEndpointMethods = { /** * **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`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ deleteForIssueComment: { ( @@ -8502,7 +8278,7 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ deleteForPullRequestComment: { ( @@ -8516,7 +8292,7 @@ export type RestEndpointMethods = { /** * **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ deleteForRelease: { ( @@ -8530,7 +8306,7 @@ export type RestEndpointMethods = { /** * **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`. * - * Delete 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/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ deleteForTeamDiscussion: { ( @@ -8544,7 +8320,7 @@ export type RestEndpointMethods = { /** * **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`. * - * Delete 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/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ deleteForTeamDiscussionComment: { ( @@ -8556,7 +8332,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [commit comment](https://docs.github.com/rest/reference/repos#comments). + * List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ listForCommitComment: { ( @@ -8568,7 +8344,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to an [issue](https://docs.github.com/rest/reference/issues). + * List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ listForIssue: { ( @@ -8580,7 +8356,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to an [issue comment](https://docs.github.com/rest/reference/issues#comments). + * List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ listForIssueComment: { ( @@ -8592,7 +8368,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [pull request review comment](https://docs.github.com/rest/reference/pulls#review-comments). + * List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). */ listForPullRequestReviewComment: { ( @@ -8604,7 +8380,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * List the reactions to a [release](https://docs.github.com/rest/reference/repos#releases). + * List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ listForRelease: { ( @@ -8616,7 +8392,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **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`. */ @@ -8630,7 +8406,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * * **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`. */ @@ -8694,7 +8470,7 @@ export type RestEndpointMethods = { * * 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)." * - * The 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). + * The 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 [API](https://docs.github.com/rest/collaborators/invitations). * * **Updating an existing collaborator's permission level** * @@ -8757,6 +8533,18 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + */ + checkAutomatedSecurityFixes: { + ( + params?: RestEndpointMethodTypes["repos"]["checkAutomatedSecurityFixes"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["checkAutomatedSecurityFixes"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * 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. * @@ -9005,7 +8793,8 @@ export type RestEndpointMethods = { * * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. * - * #### Merged branch response + * Merged branch response: + * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating * a deployment. This auto-merge happens when: * * Auto-merge option is enabled in the repository @@ -9015,11 +8804,13 @@ export type RestEndpointMethods = { * If there are no new commits in the base branch, a new request to create a deployment should give a successful * response. * - * #### Merge conflict response + * Merge conflict response: + * * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * #### Failed commit status checks + * Failed commit status checks: + * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ @@ -9065,7 +8856,7 @@ export type RestEndpointMethods = { /** * Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth Apps require the `repo_deployment` scope. + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. */ createDeploymentStatus: { ( @@ -9152,7 +8943,7 @@ export type RestEndpointMethods = { * * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[Secrets](/rest/reference/actions#secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9166,9 +8957,9 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint. + * Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ createOrUpdateFileContents: { ( @@ -9257,7 +9048,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. If the repository is not public, 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`. + * 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. If the repository is not public, 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/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * **OAuth scope requirements** * @@ -9431,7 +9222,7 @@ export type RestEndpointMethods = { * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. * * Mark the active deployment as inactive by adding any non-successful deployment status. * - * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." */ deleteDeployment: { ( @@ -9465,7 +9256,7 @@ export type RestEndpointMethods = { * * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ deleteFile: { ( @@ -9602,13 +9393,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. + * Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". */ - disableLfsForRepo: { + disablePrivateVulnerabilityReporting: { ( - params?: RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["parameters"], + params?: RestEndpointMethodTypes["repos"]["disablePrivateVulnerabilityReporting"]["parameters"], ): Promise< - RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["response"] + RestEndpointMethodTypes["repos"]["disablePrivateVulnerabilityReporting"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -9688,13 +9479,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. + * Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." */ - enableLfsForRepo: { + enablePrivateVulnerabilityReporting: { ( - params?: RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["parameters"], + params?: RestEndpointMethodTypes["repos"]["enablePrivateVulnerabilityReporting"]["parameters"], ): Promise< - RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["response"] + RestEndpointMethodTypes["repos"]["enablePrivateVulnerabilityReporting"]["response"] >; defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; @@ -9712,7 +9503,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. + * Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ generateReleaseNotes: { ( @@ -9858,7 +9649,10 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Returns all rules that apply to the specified branch. + * Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. */ getBranchRules: { ( @@ -9892,7 +9686,13 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`. + * Checks the repository permission of a collaborator. The possible repository + * permissions are `admin`, `write`, `read`, and `none`. + * + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ getCollaboratorPermissionLevel: { ( @@ -10033,34 +9833,34 @@ export type RestEndpointMethods = { * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/reference/repos#custom-media-types) for + * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent + * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent * object format. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/reference/git#trees). + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/reference/git#get-a-tree). + * API](https://docs.github.com/rest/git/trees#get-a-tree). * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * #### Size limits + * Size limits: * If the requested file's size is: * * 1 MB or smaller: All features of this endpoint are supported. * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. * * Greater than 100 MB: This endpoint is not supported. * - * #### If the content is a directory + * If the content is a directory: * The response will be an array of objects, one object for each item in the directory. * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). * In the next major version of the API, the type will be returned as "submodule". * - * #### If the content is a symlink + * If the content is a symlink: * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object * describing the symlink itself. * - * #### If the content is a submodule + * If the content is a submodule: * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out * the submodule at that specific commit. @@ -10303,7 +10103,7 @@ export type RestEndpointMethods = { /** * Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ getReadme: { ( @@ -10315,7 +10115,7 @@ export type RestEndpointMethods = { /** * Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. */ getReadmeInDirectory: { ( @@ -10457,7 +10257,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ getWebhook: { ( @@ -10467,7 +10267,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/webhooks/repos#get-a-repository-webhook)." * * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ @@ -10492,6 +10292,21 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. + * + * For more information about viewing repository activity, + * see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + */ + listActivities: { + ( + params?: RestEndpointMethodTypes["repos"]["listActivities"]["parameters"], + ): Promise< + RestEndpointMethodTypes["repos"]["listActivities"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * This returns a list of autolinks configured for the given repository. * @@ -10558,7 +10373,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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/). + * Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). * * Comments are ordered by ascending ID. */ @@ -10808,6 +10623,8 @@ export type RestEndpointMethods = { }; /** * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ listPullRequestsAssociatedWithCommit: { ( @@ -10829,7 +10646,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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). + * 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/repos/repos#list-repository-tags). * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ @@ -11180,6 +10997,7 @@ export type RestEndpointMethods = { }; /** * 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://docs.github.com/articles/about-repository-transfers/). + * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ transfer: { ( @@ -11189,7 +11007,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * **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. + * **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. */ update: { ( @@ -11356,7 +11174,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ updateWebhook: { ( @@ -11366,7 +11184,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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)." + * 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/webhooks/repos#update-a-repository-webhook)." * * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ @@ -11395,7 +11213,7 @@ export type RestEndpointMethods = { * When 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. * * **Notes:** - * * 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)" + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * 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. @@ -11414,7 +11232,7 @@ export type RestEndpointMethods = { /** * 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). * - * When 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). + * When 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/search/search#text-match-metadata). * * For 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: * @@ -11422,7 +11240,7 @@ export type RestEndpointMethods = { * * This 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. * - * #### Considerations for code search + * Considerations for code search: * * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * @@ -11444,7 +11262,7 @@ export type RestEndpointMethods = { * Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). * * When 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 - * metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For 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: * @@ -11461,7 +11279,7 @@ export type RestEndpointMethods = { * 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). * * When 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 - * search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata). + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * @@ -11469,7 +11287,7 @@ export type RestEndpointMethods = { * * This 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. * - * **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)." + * **Note:** For requests made by GitHub Apps with a user access token, 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)." */ issuesAndPullRequests: { ( @@ -11483,7 +11301,7 @@ export type RestEndpointMethods = { /** * 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). * - * When 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). + * When 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/search/search#text-match-metadata). * * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * @@ -11501,7 +11319,7 @@ export type RestEndpointMethods = { /** * 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). * - * When 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). + * When 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/search/search#text-match-metadata). * * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * @@ -11519,7 +11337,7 @@ export type RestEndpointMethods = { /** * 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://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When 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). + * When 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/search/search#text-match-metadata). * * For 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: * @@ -11537,13 +11355,15 @@ export type RestEndpointMethods = { /** * 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). * - * When searching for users, you can get text match metadata for the issue **login**, public **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). + * When searching for users, you can get text match metadata for the issue **login**, public **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/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * * For example, if you're looking for a list of popular users, you might try this query: * * `q=tom+repos:%3E42+followers:%3E1000` * * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." */ users: { ( @@ -11677,6 +11497,36 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." + * + * You may request a CVE for public repositories, but cannot do so for private repositories. + * + * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * + * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + */ + createRepositoryAdvisoryCveRequest: { + ( + params?: RestEndpointMethodTypes["securityAdvisories"]["createRepositoryAdvisoryCveRequest"]["parameters"], + ): Promise< + RestEndpointMethodTypes["securityAdvisories"]["createRepositoryAdvisoryCveRequest"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. + */ + getGlobalAdvisory: { + ( + params?: RestEndpointMethodTypes["securityAdvisories"]["getGlobalAdvisory"]["parameters"], + ): Promise< + RestEndpointMethodTypes["securityAdvisories"]["getGlobalAdvisory"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. * You can access any published security advisory on a public repository. @@ -11695,6 +11545,34 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; + /** + * Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. + * + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + */ + listGlobalAdvisories: { + ( + params?: RestEndpointMethodTypes["securityAdvisories"]["listGlobalAdvisories"]["parameters"], + ): Promise< + RestEndpointMethodTypes["securityAdvisories"]["listGlobalAdvisories"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; + /** + * Lists repository security advisories for an organization. + * + * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + */ + listOrgRepositoryAdvisories: { + ( + params?: RestEndpointMethodTypes["securityAdvisories"]["listOrgRepositoryAdvisories"]["parameters"], + ): Promise< + RestEndpointMethodTypes["securityAdvisories"]["listOrgRepositoryAdvisories"]["response"] + >; + defaults: RequestInterface["defaults"]; + endpoint: EndpointInterface<{ url: string }>; + }; /** * Lists security advisories in a repository. * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission @@ -11949,7 +11827,7 @@ export type RestEndpointMethods = { * **Note:** * The response contains the `state` of the membership and the member's `role`. * - * The `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). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ getMembershipForUserInOrg: { ( @@ -12205,7 +12083,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. + */ block: { ( params?: RestEndpointMethodTypes["users"]["block"]["parameters"], @@ -12213,7 +12093,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. + */ checkBlocked: { ( params?: RestEndpointMethodTypes["users"]["checkBlocked"]["parameters"], @@ -12435,7 +12317,7 @@ export type RestEndpointMethods = { * * The `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). * - * The 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)". + * The 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/users/emails)". */ getByUsername: { ( @@ -12686,7 +12568,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. * @deprecated octokit.rest.users.listPublicEmailsForAuthenticated() has been renamed to octokit.rest.users.listPublicEmailsForAuthenticatedUser() (2021-10-05) */ listPublicEmailsForAuthenticated: { @@ -12699,7 +12581,7 @@ export type RestEndpointMethods = { endpoint: EndpointInterface<{ url: string }>; }; /** - * 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. + * 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/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. */ listPublicEmailsForAuthenticatedUser: { ( @@ -12820,7 +12702,9 @@ export type RestEndpointMethods = { defaults: RequestInterface["defaults"]; endpoint: EndpointInterface<{ url: string }>; }; - + /** + * Unblocks the given user and returns a 204. + */ unblock: { ( params?: RestEndpointMethodTypes["users"]["unblock"]["parameters"], diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts index d409143ce..7bac0ba4a 100644 --- a/src/generated/parameters-and-response-types.ts +++ b/src/generated/parameters-and-response-types.ts @@ -34,14 +34,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["response"]; }; - addSelectedRepoToRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["response"]; - }; approveWorkflowRun: { parameters: RequestParameters & Omit< @@ -138,14 +130,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /repos/{owner}/{repo}/actions/variables"]["response"]; }; - createRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["POST /orgs/{org}/actions/required_workflows"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["POST /orgs/{org}/actions/required_workflows"]["response"]; - }; createWorkflowDispatch: { parameters: RequestParameters & Omit< @@ -226,14 +210,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /repos/{owner}/{repo}/actions/variables/{name}"]["response"]; }; - deleteRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"]; - }; deleteSelfHostedRunnerFromOrg: { parameters: RequestParameters & Omit< @@ -514,22 +490,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["response"]; }; - getRepoRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}"]["response"]; - }; - getRepoRequiredWorkflowUsage: { - parameters: RequestParameters & - Omit< - Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing"]["response"]; - }; getRepoSecret: { parameters: RequestParameters & Omit< @@ -546,14 +506,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/variables/{name}"]["response"]; }; - getRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"]; - }; getReviewsForRun: { parameters: RequestParameters & Omit< @@ -714,14 +666,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/organization-variables"]["response"]; }; - listRepoRequiredWorkflows: { - parameters: RequestParameters & - Omit< - Endpoints["GET /repos/{org}/{repo}/actions/required_workflows"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows"]["response"]; - }; listRepoSecrets: { parameters: RequestParameters & Omit< @@ -746,22 +690,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"]; }; - listRequiredWorkflowRuns: { - parameters: RequestParameters & - Omit< - Endpoints["GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs"]["response"]; - }; - listRequiredWorkflows: { - parameters: RequestParameters & - Omit< - Endpoints["GET /orgs/{org}/actions/required_workflows"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /orgs/{org}/actions/required_workflows"]["response"]; - }; listRunnerApplicationsForOrg: { parameters: RequestParameters & Omit< @@ -802,14 +730,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"]; }; - listSelectedRepositoriesRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["response"]; - }; listSelfHostedRunnersForOrg: { parameters: RequestParameters & Omit< @@ -922,14 +842,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["response"]; }; - removeSelectedRepoFromRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["response"]; - }; reviewCustomGatesForRun: { parameters: RequestParameters & Omit< @@ -1026,14 +938,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories"]["response"]; }; - setSelectedReposToRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["response"]; - }; setSelectedRepositoriesEnabledGithubActionsOrganization: { parameters: RequestParameters & Omit< @@ -1074,14 +978,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PATCH /repos/{owner}/{repo}/actions/variables/{name}"]["response"]; }; - updateRequiredWorkflow: { - parameters: RequestParameters & - Omit< - Endpoints["PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"]; - }; }; activity: { checkRepoIsStarredByAuthenticatedUser: { @@ -2008,14 +1904,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /repos/{owner}/{repo}/codespaces"]["response"]; }; - deleteCodespacesBillingUsers: { - parameters: RequestParameters & - Omit< - Endpoints["DELETE /orgs/{org}/codespaces/billing/selected_users"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["DELETE /orgs/{org}/codespaces/billing/selected_users"]["response"]; - }; deleteForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2248,22 +2136,6 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/codespaces/machines"]["response"]; }; - setCodespacesBilling: { - parameters: RequestParameters & - Omit< - Endpoints["PUT /orgs/{org}/codespaces/billing"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["PUT /orgs/{org}/codespaces/billing"]["response"]; - }; - setCodespacesBillingUsers: { - parameters: RequestParameters & - Omit< - Endpoints["POST /orgs/{org}/codespaces/billing/selected_users"]["parameters"], - "baseUrl" | "headers" | "mediaType" - >; - response: Endpoints["POST /orgs/{org}/codespaces/billing/selected_users"]["response"]; - }; setRepositoriesForSecretForAuthenticatedUser: { parameters: RequestParameters & Omit< @@ -2313,6 +2185,64 @@ export type RestEndpointMethodTypes = { response: Endpoints["PATCH /user/codespaces/{codespace_name}"]["response"]; }; }; + copilot: { + addCopilotForBusinessSeatsForTeams: { + parameters: RequestParameters & + Omit< + Endpoints["POST /orgs/{org}/copilot/billing/selected_teams"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /orgs/{org}/copilot/billing/selected_teams"]["response"]; + }; + addCopilotForBusinessSeatsForUsers: { + parameters: RequestParameters & + Omit< + Endpoints["POST /orgs/{org}/copilot/billing/selected_users"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /orgs/{org}/copilot/billing/selected_users"]["response"]; + }; + cancelCopilotSeatAssignmentForTeams: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/copilot/billing/selected_teams"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/copilot/billing/selected_teams"]["response"]; + }; + cancelCopilotSeatAssignmentForUsers: { + parameters: RequestParameters & + Omit< + Endpoints["DELETE /orgs/{org}/copilot/billing/selected_users"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["DELETE /orgs/{org}/copilot/billing/selected_users"]["response"]; + }; + getCopilotOrganizationDetails: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/copilot/billing"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/copilot/billing"]["response"]; + }; + getCopilotSeatAssignmentDetailsForUser: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/members/{username}/copilot"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/members/{username}/copilot"]["response"]; + }; + listCopilotSeats: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/copilot/billing/seats"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/copilot/billing/seats"]["response"]; + }; + }; dependabot: { addSelectedRepoToOrgSecret: { parameters: RequestParameters & @@ -3709,34 +3639,34 @@ export type RestEndpointMethodTypes = { listPatGrantRepositories: { parameters: RequestParameters & Omit< - Endpoints["GET /organizations/{org}/personal-access-tokens/{pat_id}/repositories"]["parameters"], + Endpoints["GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /organizations/{org}/personal-access-tokens/{pat_id}/repositories"]["response"]; + response: Endpoints["GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories"]["response"]; }; listPatGrantRequestRepositories: { parameters: RequestParameters & Omit< - Endpoints["GET /organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["parameters"], + Endpoints["GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["response"]; + response: Endpoints["GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories"]["response"]; }; listPatGrantRequests: { parameters: RequestParameters & Omit< - Endpoints["GET /organizations/{org}/personal-access-token-requests"]["parameters"], + Endpoints["GET /orgs/{org}/personal-access-token-requests"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /organizations/{org}/personal-access-token-requests"]["response"]; + response: Endpoints["GET /orgs/{org}/personal-access-token-requests"]["response"]; }; listPatGrants: { parameters: RequestParameters & Omit< - Endpoints["GET /organizations/{org}/personal-access-tokens"]["parameters"], + Endpoints["GET /orgs/{org}/personal-access-tokens"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["GET /organizations/{org}/personal-access-tokens"]["response"]; + response: Endpoints["GET /orgs/{org}/personal-access-tokens"]["response"]; }; listPendingInvitations: { parameters: RequestParameters & @@ -3837,18 +3767,18 @@ export type RestEndpointMethodTypes = { reviewPatGrantRequest: { parameters: RequestParameters & Omit< - Endpoints["POST /organizations/{org}/personal-access-token-requests/{pat_request_id}"]["parameters"], + Endpoints["POST /orgs/{org}/personal-access-token-requests/{pat_request_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /organizations/{org}/personal-access-token-requests/{pat_request_id}"]["response"]; + response: Endpoints["POST /orgs/{org}/personal-access-token-requests/{pat_request_id}"]["response"]; }; reviewPatGrantRequestsInBulk: { parameters: RequestParameters & Omit< - Endpoints["POST /organizations/{org}/personal-access-token-requests"]["parameters"], + Endpoints["POST /orgs/{org}/personal-access-token-requests"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /organizations/{org}/personal-access-token-requests"]["response"]; + response: Endpoints["POST /orgs/{org}/personal-access-token-requests"]["response"]; }; setMembershipForUser: { parameters: RequestParameters & @@ -3893,18 +3823,18 @@ export type RestEndpointMethodTypes = { updatePatAccess: { parameters: RequestParameters & Omit< - Endpoints["POST /organizations/{org}/personal-access-tokens/{pat_id}"]["parameters"], + Endpoints["POST /orgs/{org}/personal-access-tokens/{pat_id}"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /organizations/{org}/personal-access-tokens/{pat_id}"]["response"]; + response: Endpoints["POST /orgs/{org}/personal-access-tokens/{pat_id}"]["response"]; }; updatePatAccesses: { parameters: RequestParameters & Omit< - Endpoints["POST /organizations/{org}/personal-access-tokens"]["parameters"], + Endpoints["POST /orgs/{org}/personal-access-tokens"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["POST /organizations/{org}/personal-access-tokens"]["response"]; + response: Endpoints["POST /orgs/{org}/personal-access-tokens"]["response"]; }; updateWebhook: { parameters: RequestParameters & @@ -4814,6 +4744,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users"]["response"]; }; + checkAutomatedSecurityFixes: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/automated-security-fixes"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/automated-security-fixes"]["response"]; + }; checkCollaborator: { parameters: RequestParameters & Omit< @@ -5238,13 +5176,13 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}"]["response"]; }; - disableLfsForRepo: { + disablePrivateVulnerabilityReporting: { parameters: RequestParameters & Omit< - Endpoints["DELETE /repos/{owner}/{repo}/lfs"]["parameters"], + Endpoints["DELETE /repos/{owner}/{repo}/private-vulnerability-reporting"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["DELETE /repos/{owner}/{repo}/lfs"]["response"]; + response: Endpoints["DELETE /repos/{owner}/{repo}/private-vulnerability-reporting"]["response"]; }; disableVulnerabilityAlerts: { parameters: RequestParameters & @@ -5286,13 +5224,13 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["PUT /repos/{owner}/{repo}/automated-security-fixes"]["response"]; }; - enableLfsForRepo: { + enablePrivateVulnerabilityReporting: { parameters: RequestParameters & Omit< - Endpoints["PUT /repos/{owner}/{repo}/lfs"]["parameters"], + Endpoints["PUT /repos/{owner}/{repo}/private-vulnerability-reporting"]["parameters"], "baseUrl" | "headers" | "mediaType" >; - response: Endpoints["PUT /repos/{owner}/{repo}/lfs"]["response"]; + response: Endpoints["PUT /repos/{owner}/{repo}/private-vulnerability-reporting"]["response"]; }; enableVulnerabilityAlerts: { parameters: RequestParameters & @@ -5750,6 +5688,14 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}"]["response"]; }; + listActivities: { + parameters: RequestParameters & + Omit< + Endpoints["GET /repos/{owner}/{repo}/activity"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /repos/{owner}/{repo}/activity"]["response"]; + }; listAutolinks: { parameters: RequestParameters & Omit< @@ -6412,6 +6358,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["POST /repos/{owner}/{repo}/security-advisories"]["response"]; }; + createRepositoryAdvisoryCveRequest: { + parameters: RequestParameters & + Omit< + Endpoints["POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve"]["response"]; + }; + getGlobalAdvisory: { + parameters: RequestParameters & + Omit< + Endpoints["GET /advisories/{ghsa_id}"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /advisories/{ghsa_id}"]["response"]; + }; getRepositoryAdvisory: { parameters: RequestParameters & Omit< @@ -6420,6 +6382,22 @@ export type RestEndpointMethodTypes = { >; response: Endpoints["GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}"]["response"]; }; + listGlobalAdvisories: { + parameters: RequestParameters & + Omit< + Endpoints["GET /advisories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /advisories"]["response"]; + }; + listOrgRepositoryAdvisories: { + parameters: RequestParameters & + Omit< + Endpoints["GET /orgs/{org}/security-advisories"]["parameters"], + "baseUrl" | "headers" | "mediaType" + >; + response: Endpoints["GET /orgs/{org}/security-advisories"]["response"]; + }; listRepositoryAdvisories: { parameters: RequestParameters & Omit<