The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -253097,7 +253097,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -170409,7 +170409,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -266652,7 +266652,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
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.
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.
You 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.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"
You must authenticate using an access token with the admin:enterprise scope to use this endpoint.
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.\"
You 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.
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.\"
You 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.
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.\"
You 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.
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.\"
You 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.
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 internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\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.
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 internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\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.
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 internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\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.
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 internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"
\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.
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.\"
You 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.
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.\"
You 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.
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.\"
You 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.
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.\"
You 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.
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\nencrypted values.
\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.
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\nencrypt a secret before you can create or update secrets.
\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.
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.
\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.
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" }, { "type": "string", @@ -6425,7 +6425,7 @@ "type": "array of integers", "name": "selected_repository_ids", "in": "body", - "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, Set selected repositories for an organization secret, and 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, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to\nuse this endpoint.
*Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\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});\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nCreates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\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.
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.
\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.
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\nfor 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.\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.
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 and 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 and Remove selected repository from an organization secret endpoints.
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. 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\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You 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.
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. 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\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.
You 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.
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. 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\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.
You 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.
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\nvalues.
\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.
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\nvalues.
\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.
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\nencrypt a secret before you can create or update secrets.
\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.
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.
\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.
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" }, { "type": "string", @@ -8292,7 +8306,7 @@ } ], "previews": [], - "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\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});\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nCreates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\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.
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.
\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.
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\nencrypted values.
\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.
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\nsecrets. You need to encrypt a secret before you can create or update secrets.
\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.
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.
\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.
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
", + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
", "isRequired": true }, { @@ -8814,7 +8828,7 @@ } ], "previews": [], - "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\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});\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nCreates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\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.
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.
\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.
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the new runner.
", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "The ID of the runner group to register the runner to.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.
", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "The working directory to be used for job execution, relative to the runner install directory.
", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "enterprise": "ENTERPRISE" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "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" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Generates a configuration that can be passed to the runner application at startup.
\nYou must authenticate using an access token with the manage_runners:enterprise scope to use this endpoint.
Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", @@ -17552,7 +17802,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all self-hosted runners configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all self-hosted runners configured in an organization.
\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.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\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.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the new runner.
", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "The ID of the runner group to register the runner to.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.
", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "The working directory to be used for job execution, relative to the runner install directory.
", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "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" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Generates a configuration that can be passed to the runner application at startup.
\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.
Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", @@ -19250,7 +19722,7 @@ } ], "previews": [], - "descriptionHTML": "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.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns 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.\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.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.
./config.sh --url https://github.com/octo-org --token TOKEN\nReturns 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.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nReturns 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.\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.
Example using remove token:
\nTo remove your self-hosted runner from an organization, replace TOKEN with the remove token provided by this\nendpoint.
./config.sh remove --token TOKEN\nGets a specific self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Gets a specific self-hosted runner configured in an organization.
\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.
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.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
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.
\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.
Lists all labels for a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Lists all labels for a self-hosted runner configured in an organization.
\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.
Add custom labels to a self-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Add custom labels to a self-hosted runner configured in an organization.
\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.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.
\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.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the admin:org scope to use this endpoint.
Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.
\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.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the admin:org scope to use this endpoint.
Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You 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.
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.
\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.
Lists binaries for the runner application that you can download and run.
\nYou must authenticate using an access token with the repo scope to use this endpoint.
Lists binaries for the runner application that you can download and run.
\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.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the new runner.
", + "isRequired": true + }, + { + "type": "integer", + "name": "runner_group_id", + "in": "body", + "description": "The ID of the runner group to register the runner to.
", + "isRequired": true + }, + { + "type": "array of strings", + "name": "labels", + "in": "body", + "description": "The names of the custom labels to add to the runner. Minimum items: 1. Maximum items: 100.
", + "isRequired": true + }, + { + "type": "string", + "name": "work_folder", + "in": "body", + "description": "The working directory to be used for job execution, relative to the runner install directory.
", + "default": "_work" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "New runner", + "runner_group_id": 1, + "labels": [ + "self-hosted", + "X64", + "macOS", + "no-gpu" + ], + "work_folder": "_work" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "runner": { + "id": 23, + "name": "New runner", + "os": "unknown", + "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" + } + ] + }, + "encoded_jit_config": "abc123" + }, + "schema": { + "type": "object", + "required": [ + "runner", + "encoded_jit_config" + ], + "properties": { + "runner": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "examples": [ + "iMac" + ] + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "examples": [ + "macos" + ] + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "encoded_jit_config": { + "type": "string", + "description": "The base64 encoded runner configuration." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Generates a configuration that can be passed to the runner application at startup.
\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.
Created
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "post", @@ -23671,7 +24375,7 @@ } ], "previews": [], - "descriptionHTML": "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.
Example using registration token:
\nConfigure 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\nReturns a token that you can pass to the config script. The token\nexpires after one hour.
You 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.
Example using registration token:
\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided\nby this endpoint.
config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN
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.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.
\n./config.sh remove --token TOKEN\nReturns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.
\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.
Example using remove token:
\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.
\nconfig.sh remove --token TOKEN
Gets a specific self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Gets a specific self-hosted runner configured in a repository.
\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.
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.
\nYou must authenticate using an access token with the repo\nscope to use this endpoint.
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.
\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.
Lists all labels for a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Lists all labels for a self-hosted runner configured in a repository.
\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.
Add custom labels to a self-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Add custom labels to a self-hosted runner configured in a repository.
\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.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.
\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.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\nYou must authenticate using an access token with the repo scope to use this\nendpoint.
Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.
\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.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You must authenticate using an access token with the repo scope to use this\nendpoint.
Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.
\nThis endpoint returns a 404 Not Found status if the custom label is not\npresent on the runner.
You 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.
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.\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.
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.
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.\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.
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.
\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.
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.
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.\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.
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.
Deletes an organization variable using the variable name.
\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.
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\nthat is available to selected repositories.
\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.
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\nto selected repositories. Organization variables that are available to selected\nrepositories have their visibility field set to selected.
You 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.
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.\nOrganization 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.\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.
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\navailable to selected repositories. Organization variables that are available to\nselected repositories have their visibility field set to selected.
You 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.
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.
\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.
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.\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.
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.
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.\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.
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.
\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.
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.
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.\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.
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.
Deletes a repository variable using the variable name.
\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.
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.
\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.
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.
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.\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.
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.
\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.
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.
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.\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.
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.
Deletes an environment variable using the variable name.
\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.
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.
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.
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.
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.
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.
\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.
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"
Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", "in": "query", "required": false, "schema": { @@ -32609,6 +33327,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -33399,6 +34131,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -33525,7 +34271,7 @@ } ], "previews": [], - "descriptionHTML": "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.
\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.
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.
\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.
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.\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.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "environment_name": "prod-eus", + "state": "approved", + "comment": "All health checks passed." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "run_id": "RUN_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"
\nNote: 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.
If 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.
No Content
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -39720,6 +40593,7 @@ "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", @@ -40004,6 +40878,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -40120,6 +40997,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -41216,7 +42100,7 @@ }, { "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.\"
Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"
Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", + "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"
", "in": "query", "required": false, "schema": { @@ -43018,6 +43902,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -43808,6 +44706,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -43934,7 +44846,7 @@ } ], "previews": [], - "descriptionHTML": "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.
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.
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.
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.
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.
You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook 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.\"
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. For more information, see \"Creating a personal access token for the command line.\"
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.
You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook 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.\"
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. For more information, see \"Creating a personal access token for the command line.\"
GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", + "descriptionHTML": "GitHub Enterprise Server provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:
\nNote: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.
", "statusCodes": [ { "httpStatusCode": "200", @@ -82195,6 +83107,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -82414,7 +83340,7 @@ } ], "previews": [], - "descriptionHTML": "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 Enterprise Server 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 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 Enterprise Server 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 endpoint and pass the query parameter all=false.
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).
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).
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).
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).
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).
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).
This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.
\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.
", + "descriptionHTML": "This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -83627,7 +84567,7 @@ "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).
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).
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.
\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.
\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
", + "descriptionHTML": "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.
\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.
\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -83765,7 +84705,7 @@ "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).
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).
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 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 endpoint and set ignore to true.
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 Enterprise Server 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 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 Enterprise Server 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 endpoint and pass the query parameter all=false.
Lists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
Lists the people that have starred the repository.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
Lists repositories the authenticated user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
Lists repositories the authenticated user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
Lists repositories a user has starred.
\nYou can also find out when stars were created by passing the following custom media type via the Accept header: application/vnd.github.star+json.
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 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 completely.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -93968,6 +94922,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -94954,6 +95922,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -95096,7 +96078,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -95165,7 +96147,7 @@ "type": "string or null", "name": "announcement", "in": "body", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", "isRequired": true }, { @@ -95211,7 +96193,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -95697,7 +96679,7 @@ } ], "previews": [], - "descriptionHTML": "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\" endpoint.
You must use a JWT to access this endpoint.
", + "descriptionHTML": "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\" endpoint.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -96144,7 +97126,7 @@ } ], "previews": [], - "descriptionHTML": "Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. 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.
Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. 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.
You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
You must use a JWT to access this endpoint.
\nThe permissions the installation has are included under the permissions key.
Enables an authenticated GitHub App to find an installation's information using the installation id.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Enables an authenticated GitHub App to find an installation's information using the installation id.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -98693,7 +99675,7 @@ } ], "previews": [], - "descriptionHTML": "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\" endpoint.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "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\" endpoint.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -101020,7 +102002,7 @@ } ], "previews": [], - "descriptionHTML": "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.
You must use a JWT to access this endpoint.
", + "descriptionHTML": "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.
You must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "201", @@ -101086,7 +102068,7 @@ } ], "previews": [], - "descriptionHTML": "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 Enterprise Server API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "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 Enterprise Server API or webhook events is blocked for that account.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -101140,7 +102122,7 @@ } ], "previews": [], - "descriptionHTML": "Removes a GitHub App installation suspension.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Removes a GitHub App installation suspension.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -102404,7 +103386,7 @@ } ], "previews": [], - "descriptionHTML": "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 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 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.
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).
If 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 or an installation access token to access this endpoint.
", + "descriptionHTML": "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).
If 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 or an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -103787,7 +104769,7 @@ } ], "previews": [], - "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Enables an authenticated GitHub App to find the organization's installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -104744,7 +105726,7 @@ } ], "previews": [], - "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "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.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -105699,7 +106681,7 @@ } ], "previews": [], - "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Enables an authenticated GitHub App to find the user’s installation information.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -107366,7 +108348,7 @@ } ], "previews": [], - "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", + "descriptionHTML": "List repositories that an app installation can access.
\nYou must use an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -107410,7 +108392,7 @@ } ], "previews": [], - "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\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\" endpoint.
\nYou must use an installation access token to access this endpoint.
", + "descriptionHTML": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.
\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\" endpoint.
\nYou must use an installation access token to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -108433,7 +109415,7 @@ } ], "previews": [], - "descriptionHTML": "Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.
\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.
\nYou can find the permissions for the installation under the permissions key.
Lists installations of your GitHub App that the authenticated user has explicit permission (:read, :write, or :admin) to access.
You must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.
\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.
\nYou can find the permissions for the installation under the permissions key.
List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.
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.
\nYou must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe access the user has to each repository is included in the hash under the permissions key.
List repositories that the authenticated user has explicit permission (:read, :write, or :admin) to access for an installation.
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.
\nYou must use a user access token, created for a user who has authorized your GitHub App, to access this endpoint.
\nThe access the user has to each repository is included in the hash under the permissions key.
Add a single repository to an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", + "descriptionHTML": "Add a single repository to an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -110273,7 +111255,7 @@ } ], "previews": [], - "descriptionHTML": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.
\nYou must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", + "descriptionHTML": "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.
You must use a personal access token (which you can create via the command line or Basic Authentication) to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "204", @@ -110290,6 +111272,10 @@ { "httpStatusCode": "404", "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Returned when the application is installed on all repositories in the organization, or if this request would remove the last repository that the application has access to in the organization.
OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use 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.
OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use 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.
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 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.
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 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.
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 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.
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 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.
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 when accessing this endpoint, using the application's client_id and client_secret as the username and password.
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 when accessing this endpoint, using the application's client_id and client_secret as the username and password.
Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -112322,7 +113308,7 @@ "type": "string", "name": "secret", "in": "body", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -112602,7 +113588,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -112865,7 +113851,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Returns a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -112923,7 +113909,7 @@ } ], "previews": [], - "descriptionHTML": "Redeliver a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", + "descriptionHTML": "Redeliver a delivery for the webhook configured for a GitHub App.
\nYou must use a JWT to access this endpoint.
", "statusCodes": [ { "httpStatusCode": "202", @@ -113525,6 +114511,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -113641,6 +114630,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -114247,6 +115243,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -114363,6 +115362,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -114902,6 +115908,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -115248,7 +116257,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -116377,6 +117386,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -116493,6 +117505,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -117099,6 +118118,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -117215,6 +118237,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -117754,6 +118783,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -118118,7 +119150,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -119258,6 +120290,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -119374,6 +120409,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -119980,6 +121022,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120096,6 +121141,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -120635,6 +121687,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -120955,7 +122010,7 @@ } ], "previews": [], - "descriptionHTML": "Renames a branch in a repository.
\nNote: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.
\nTo rename a non-default branch:
\ncontents:write repository permission.To rename the default branch:
\nadministration:write repository permission.Renames a branch in a repository.
\nNote: Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".
\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.
\nTo rename a non-default branch:
\ncontents:write repository permission.To rename the default branch:
\nadministration:write repository permission.The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -122064,6 +123119,7 @@ "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", @@ -122150,6 +123206,7 @@ "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", @@ -122507,6 +123564,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -122623,6 +123683,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -123229,6 +124296,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -123345,6 +124415,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -123884,6 +124961,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -124178,7 +125258,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -124218,7 +125298,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -124311,7 +125391,7 @@ { "type": "boolean", "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until code owners review them.
" + "description": "Blocks merging pull requests until code owners review them.
" }, { "type": "integer", @@ -124378,19 +125458,19 @@ "type": "boolean", "name": "required_linear_history", "in": "body", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.
Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.
Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"
Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"
Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.
Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.
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 in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote: Passing new arrays of users and teams replaces their previous values.
Note: The list of users, apps, and teams in total is limited to 100 items.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nProtecting a branch requires admin or owner permissions to the repository.
\nNote: Passing new arrays of users and teams replaces their previous values.
Note: The list of users, apps, and teams in total is limited to 100 items.
", "statusCodes": [ { "httpStatusCode": "200", @@ -126565,7 +127668,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -126595,7 +127698,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -126635,7 +127738,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -126694,7 +127797,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -126730,7 +127833,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -126789,7 +127892,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "200", @@ -126825,7 +127928,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -126855,7 +127958,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "204", @@ -126895,7 +127998,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -126960,6 +128063,7 @@ "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", @@ -127218,6 +128322,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -127334,6 +128441,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -127940,6 +129054,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -128056,6 +129173,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -128484,7 +129608,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -128520,7 +129644,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -128563,7 +129687,7 @@ "type": "boolean", "name": "require_code_owner_reviews", "in": "body", - "description": "Blocks merging pull requests until code owners have reviewed.
" + "description": "Blocks merging pull requests until code owners have reviewed.
" }, { "type": "integer", @@ -128686,6 +129810,7 @@ "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", @@ -128944,6 +130069,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -129060,6 +130188,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -129666,6 +130801,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -129782,6 +130920,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -130210,7 +131355,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
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 in the GitHub Help documentation.
\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
\nNote: Passing new arrays of users and teams replaces their previous values.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130280,7 +131425,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -130320,7 +131465,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130379,7 +131524,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.
Note: You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "200", @@ -130419,7 +131564,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130478,7 +131623,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "200", @@ -130518,7 +131663,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130548,7 +131693,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.
", "statusCodes": [ { "httpStatusCode": "204", @@ -130588,7 +131733,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130694,7 +131839,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -130734,7 +131879,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130879,7 +132024,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.
", "statusCodes": [ { "httpStatusCode": "200", @@ -130923,7 +132068,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -130953,7 +132098,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -130989,7 +132134,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131029,7 +132174,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -131069,7 +132214,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131125,7 +132270,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -131173,7 +132318,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131227,7 +132372,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -131271,7 +132416,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131325,7 +132470,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -131369,7 +132514,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131433,6 +132578,7 @@ "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", @@ -131592,6 +132738,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -131790,7 +132939,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
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 in the GitHub Help documentation.
\nLists who has access to this protected branch.
\nNote: Users, apps, and teams restrictions are only available for organization-owned repositories.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -131860,7 +133009,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nDisables the ability to restrict who can push to this branch.
", "statusCodes": [ { "httpStatusCode": "204", @@ -131896,7 +133045,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -132298,7 +133447,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\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.
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 in the GitHub Help documentation.
\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.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -132754,7 +133903,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
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 in the GitHub Help documentation.
\nGrants the specified apps push access for this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -133210,7 +134359,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
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 in the GitHub Help documentation.
\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -133666,7 +134815,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
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 in the GitHub Help documentation.
\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with write access to the contents permission can be added as authorized actors on a protected branch.
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -133743,6 +134892,7 @@ "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", @@ -133777,6 +134927,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -133893,6 +135046,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -133956,7 +135116,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the teams who have push access to this branch. The list includes child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -133996,7 +135156,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -134047,6 +135207,7 @@ "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", @@ -134081,6 +135242,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -134197,6 +135361,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -134260,7 +135431,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified teams push access for this branch. You can also give push access to child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -134300,7 +135471,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -134351,6 +135522,7 @@ "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", @@ -134385,6 +135557,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -134501,6 +135676,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -134564,7 +135746,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -134604,7 +135786,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -134655,6 +135837,7 @@ "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", @@ -134689,6 +135872,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -134805,6 +135991,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -134868,7 +136061,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -134908,7 +136101,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -135125,7 +136318,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nLists the people who have push access to this branch.
", "statusCodes": [ { "httpStatusCode": "200", @@ -135165,7 +136358,7 @@ }, { "name": "branch", - "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -135396,7 +136589,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
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 in the GitHub Help documentation.
\nGrants the specified people push access for this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -135667,7 +136860,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
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 in the GitHub Help documentation.
\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
", "in": "path", "required": true, "schema": { @@ -135938,7 +137131,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
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 in the GitHub Help documentation.
\nRemoves the ability of a user to push to this branch.
\n\n\n\n\n\n\n\n\n\n\n\n\n\n| Type | Description |
|---|---|
array | Usernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items. |
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 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\".
", + "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 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\".
", "childParamsGroups": [ { "type": "string", @@ -136163,7 +137356,7 @@ "type": "array of objects", "name": "actions", "in": "body", - "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 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.\"
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 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.\"
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 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\".
", + "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 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\".
", "childParamsGroups": [ { "type": "string", @@ -140005,7 +141198,7 @@ "type": "array of objects", "name": "actions", "in": "body", - "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 description. To learn more about check runs and requested actions, see \"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. See the actions object description. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook 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\".
", + "descriptionHTML": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook 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\".
", "statusCodes": [ { "httpStatusCode": "201", @@ -145708,6 +146901,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -147488,6 +148695,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -147712,7 +148933,7 @@ } ], "previews": [], - "descriptionHTML": "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. 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\". Your GitHub App must have the checks:write permission to create check suites.
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. 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\". Your GitHub App must have the checks:write permission to create 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. You must have admin permissions in the repository to set preferences for check suites.
", + "descriptionHTML": "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. You must have admin permissions in the repository to set preferences for check suites.
", "statusCodes": [ { "httpStatusCode": "200", @@ -150468,6 +151703,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -150766,7 +152015,7 @@ } ], "previews": [], - "descriptionHTML": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook 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.
Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook 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.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -152591,7 +153854,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -153929,7 +155192,7 @@ } ], "previews": [], - "descriptionHTML": "Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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.\"
\nTo use this endpoint, you must be a member of the enterprise,\nand you must use an access token with the repo scope or security_events scope.
Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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.\"
\nTo use this endpoint, you must be a member of the enterprise,\nand you must use an access token with the repo scope or security_events scope.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -153996,7 +155259,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -155353,7 +156616,7 @@ } ], "previews": [], - "descriptionHTML": "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.\"
\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.
For public repositories, you may instead use the public_repo scope.
GitHub Apps must have the security_events read permission to use this endpoint.
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.\"
\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.
For public repositories, you may instead use the public_repo scope.
GitHub Apps must have the security_events read permission to use this endpoint.
The CodeQL query suite to use.
", + "description": "CodeQL query suite to be used.
", "enum": [ "default", "extended" ] + }, + { + "type": "array of strings", + "name": "languages", + "in": "body", + "description": "CodeQL languages to be analyzed. Supported values are: c-cpp, csharp, go, java-kotlin, javascript-typescript, python, and ruby.
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for 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:
\nCannot assign {member} permission of {role name}\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.\"
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.
\nUpdating an existing collaborator's permission level
\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.
Rate limits
\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.
", + "descriptionHTML": "This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"
\nFor more information on permission levels, see \"Repository permission levels for 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:
\nCannot assign {member} permission of {role name}\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.\"
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.
\nUpdating an existing collaborator's permission level
\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.
Rate limits
\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.
", "statusCodes": [ { "httpStatusCode": "201", @@ -160887,7 +162170,7 @@ } ], "previews": [], - "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote: A user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", + "descriptionHTML": "Removes a collaborator from a repository.
\nTo use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.
\nThis endpoint also:
\nRemoving a user as a collaborator has the following effects on forks:
\nNote: A user can still have access to the repository through organization permissions like base repository permissions.
\nAlthough the API responds immediately, the additional permission updates might take some extra time to complete in the background.
\nFor more information on fork permissions, see \"About permissions and visibility of forks\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -162122,6 +163405,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -163517,6 +164814,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -164947,6 +166258,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -166582,7 +167907,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.
", "statusCodes": [ { "httpStatusCode": "200", @@ -166855,6 +168180,7 @@ "description": "A great team.", "privacy": "closed", "permission": "admin", + "notification_setting": "notifications_enabled", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", "parent": null @@ -168414,6 +169740,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -168530,6 +169859,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -173143,7 +174479,7 @@ } ], "previews": [], - "descriptionHTML": "Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.
Note: If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
\nYou can pass the appropriate media type to fetch diff and patch formats. Diffs with binary data will have no patch property.
To return only the SHA-1 hash of the commit reference, you can provide the sha custom media type in the Accept header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"
\nThis endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.
The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
Working with large comparisons
\nTo process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:
For more information on working with pagination, see \"Using pagination in the REST API.\"
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"
\nThis endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate media type to fetch diff and patch formats.
The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.
When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.
Working with large comparisons
\nTo process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:
For more information on working with pagination, see \"Using pagination in the REST API.\"
\nSignature verification object
\nThe response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", + "descriptionHTML": "Commit Comments use these custom media types. You can read more about the use of media types in the API here.
\nComments are ordered by ascending ID.
", "statusCodes": [ { "httpStatusCode": "200", @@ -177922,7 +179258,7 @@ } ], "previews": [], - "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Create a comment for a commit using its :commit_sha.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -178914,6 +180250,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -179838,7 +181188,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -179847,7 +181197,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -181481,7 +182831,7 @@ } ], "previews": [], - "descriptionHTML": "Lists Dependabot alerts for repositories that are owned by the specified enterprise.\nTo use this endpoint, you must be a member of the enterprise, and you must use an\naccess token with the repo scope or security_events scope.\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"
Lists Dependabot alerts for repositories that are owned by the specified enterprise.\nTo use this endpoint, you must be a member of the enterprise, and you must use an\naccess token with the repo scope or security_events scope.\nAlerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -181604,7 +182954,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -183393,7 +184743,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -183402,7 +184752,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -186107,7 +187457,7 @@ } ], "previews": [], - "descriptionHTML": "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.
To use this endpoint, you must have access to security alerts for the repository. For more information, see \"Granting access to security alerts.\"
", + "descriptionHTML": "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.
To use this endpoint, you must have access to security alerts for the repository. For more information, see \"Granting access to security alerts.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -186498,7 +187848,7 @@ "type": "string", "name": "encrypted_value", "in": "body", - "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.
" }, { "type": "string", @@ -186522,7 +187872,7 @@ "type": "array of strings", "name": "selected_repository_ids", "in": "body", - "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, Set selected repositories for an organization secret, and 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, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.
Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\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});\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nCreates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nYou must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the dependabot_secrets organization\npermission to use this endpoint.
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 and 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 and Remove selected repository from an organization secret endpoints.
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. 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. 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. 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. 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. 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. 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.
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.
" }, { "type": "string", @@ -188234,7 +189598,7 @@ } ], "previews": [], - "descriptionHTML": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. 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.
Example encrypting a secret using Node.js
\nEncrypt your secret using the libsodium-wrappers library.
\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});\nExample encrypting a secret using Python
\nEncrypt your secret using pynacl with Python 3.
\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\")\nExample encrypting a secret using C#
\nEncrypt your secret using the Sodium.Core package.
\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));\nExample encrypting a secret using Ruby
\nEncrypt your secret using the rbnacl gem.
\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)\nCreates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\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.
Forbidden
" + "description": "Response if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -189357,7 +190721,7 @@ "type": "boolean", "name": "read_only", "in": "body", - "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" + "description": "If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"
" } ], "enabledForGitHubApps": true, @@ -190508,7 +191872,7 @@ "type": "array of strings", "name": "required_contexts", "in": "body", - "description": "The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
" + "description": "The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.
" }, { "type": "object or string", @@ -191246,7 +192610,7 @@ } ], "previews": [], - "descriptionHTML": "Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The 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.
The 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.
By default, commit 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.
The 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.
The 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.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
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:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nMerge 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.
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.
Deployments offer a few configurable parameters with certain defaults.
\nThe ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them\nbefore we merge a pull request.
The 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.
The 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.
By default, commit 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.
The 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.
The 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.
Users with repo or repo_deployment scopes can create a deployment for a given ref.
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:
\nmaster in the response exampleIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.
\nMerge 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.
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.
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.
To set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
", + "descriptionHTML": "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.
To set a deployment as inactive, you must:
\nFor more information, see \"Create a deployment\" and \"Create a deployment status.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -192827,6 +194191,7 @@ "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", @@ -193180,6 +194545,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -193296,6 +194664,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -193552,6 +194927,7 @@ "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", @@ -193891,6 +195267,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -194007,6 +195386,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -194327,6 +195713,7 @@ "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", @@ -194666,6 +196053,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -194782,6 +196172,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -194997,6 +196394,753 @@ ] } ], + "protection-rules": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Get all deployment protection rules for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment.
", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "List of deployment protection rules
", + "example": { + "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" + } + } + ] + }, + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of enabled custom deployment protection rules for this environment", + "type": "integer", + "examples": [ + 10 + ] + }, + "custom_deployment_protection_rules": { + "type": "array", + "items": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the deployment protection rule.", + "examples": [ + 3515 + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the deployment protection rule is enabled for the environment.", + "examples": [ + true + ] + }, + "app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + } + } + }, + "example": "../../components/examples/deployment_protection_rules.yaml" + } + } + } + ], + "previews": [], + "descriptionHTML": "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.\"
For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
List of deployment protection rules
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules", + "title": "Create a custom deployment protection rule on an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment.
", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "integration_id", + "in": "body", + "description": "The ID of the custom app that will be enabled on the environment.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "integration_id": 5 + }, + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "The enabled custom deployment protection rule
", + "example": { + "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" + } + }, + "schema": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the deployment protection rule.", + "examples": [ + 3515 + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the deployment protection rule is enabled for the environment.", + "examples": [ + true + ] + }, + "app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Enable a custom deployment protection rule for an environment.
\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.
For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.
The enabled custom deployment protection rule
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps", + "title": "List custom deployment rule integrations available for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment.
", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of custom deployment rule integrations available for this environment.
", + "example": [ + { + "total_count": 2 + }, + { + "available_custom_deployment_protection_rule_integrations": [ + { + "id": 1, + "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy", + "slug": "a-custom-app", + "integration_url": "https://api.github.com/apps/a-custom-app" + }, + { + "id": 2, + "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy", + "slug": "another-custom-app", + "integration_url": "https://api.github.com/apps/another-custom-app" + } + ] + } + ], + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The total number of custom deployment protection rule integrations available for this environment.", + "type": "integer", + "examples": [ + 35 + ] + }, + "available_custom_deployment_protection_rule_integrations": { + "type": "array", + "items": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
For more information about environments, see \"Using environments for deployment.\"
\nFor more information about the app that is providing this custom deployment rule, see \"GET an app\".
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "A list of custom deployment rule integrations available for this environment.
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Get a custom deployment protection rule", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment.
", + "schema": { + "type": "string" + } + }, + { + "name": "protection_rule_id", + "description": "The unique identifier of the protection rule.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "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" + } + }, + "schema": { + "title": "Deployment protection rule", + "description": "Deployment protection rule", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier for the deployment protection rule.", + "examples": [ + 3515 + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + }, + "enabled": { + "type": "boolean", + "description": "Whether the deployment protection rule is enabled for the environment.", + "examples": [ + true + ] + }, + "app": { + "title": "Custom deployment protection rule app", + "description": "A GitHub App that is providing a custom deployment protection rule.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the deployment protection rule integration.", + "examples": [ + 3515 + ] + }, + "slug": { + "type": "string", + "description": "The slugified name of the deployment protection rule integration.", + "examples": [ + "my-custom-app" + ] + }, + "integration_url": { + "type": "string", + "description": "The URL for the endpoint to get details about the app.", + "examples": [ + "https://api.github.com/apps/custom-app-slug" + ] + }, + "node_id": { + "type": "string", + "description": "The node ID for the deployment protection rule integration.", + "examples": [ + "MDQ6R2F0ZTM1MTU=" + ] + } + }, + "required": [ + "id", + "slug", + "integration_url", + "node_id" + ] + } + }, + "required": [ + "id", + "node_id", + "enabled", + "app" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "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.\"
For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.
OK
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}", + "title": "Disable a custom protection rule for an environment", + "category": "deployments", + "subcategory": "protection-rules", + "parameters": [ + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment.
", + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "protection_rule_id", + "description": "The unique identifier of the protection rule.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "environment_name": "ENVIRONMENT_NAME", + "repo": "REPO", + "owner": "OWNER", + "protection_rule_id": "PROTECTION_RULE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Disables a custom deployment protection rule for an environment.
\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\".
No Content
" + } + ] + } + ], "statuses": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -200027,6 +202171,107 @@ } ] }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/enterprise/stats/security-products", + "title": "Get security products statistics", + "category": "enterprise-admin", + "subcategory": "admin-stats", + "parameters": [], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "total_repos": 150, + "nonarchived_repos": 130, + "secret_scanning_enabled_repos": 150, + "secret_scanning_push_protection_enabled_repos": 120, + "code_scanning_enabled_repos": 140, + "code_scanning_pr_reviews_enabled_repos": 100, + "code_scanning_default_setup_enabled_repos": 50, + "code_scanning_default_setup_eligible_repos": 30, + "dependabot_alerts_enabled_repos": 130, + "dependabot_security_updates_enabled_repos": 120, + "dependabot_version_updates_enabled_repos": 121, + "advanced_security_enabled_repos": 150, + "active_committers": 30, + "purchased_committers": 90, + "maximum_committers": 80 + }, + "schema": { + "title": "Enterprise Security Products Stats", + "type": "object", + "properties": { + "total_repos": { + "type": "integer" + }, + "nonarchived_repos": { + "type": "integer" + }, + "secret_scanning_enabled_repos": { + "type": "integer" + }, + "secret_scanning_push_protection_enabled_repos": { + "type": "integer" + }, + "code_scanning_enabled_repos": { + "type": "integer" + }, + "code_scanning_pr_reviews_enabled_repos": { + "type": "integer" + }, + "code_scanning_default_setup_enabled_repos": { + "type": "integer" + }, + "code_scanning_default_setup_eligible_repos": { + "type": "integer" + }, + "dependabot_alerts_enabled_repos": { + "type": "integer" + }, + "dependabot_security_updates_enabled_repos": { + "type": "integer" + }, + "dependabot_version_updates_enabled_repos": { + "type": "integer" + }, + "advanced_security_enabled_repos": { + "type": "integer" + }, + "active_committers": { + "type": "integer" + }, + "purchased_committers": { + "type": "integer" + }, + "maximum_committers": { + "type": "integer" + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the statistics about security products for a GitHub Enterprise Server instance.
\nTo use this endpoint, you must be a site admin.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -200118,7 +202363,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -200164,7 +202409,7 @@ "type": "string or null", "name": "announcement", "in": "body", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"
", "isRequired": true }, { @@ -200206,7 +202451,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.9/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.10/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", "examples": [ "Very **important** announcement about _something_." ] @@ -200292,7 +202537,7 @@ }, { "name": "phrase", - "description": "A search phrase. For more information, see Searching the audit log.
", + "description": "A search phrase. For more information, see Searching the audit log.
", "in": "query", "required": false, "schema": { @@ -200315,7 +202560,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -200324,7 +202569,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -200992,31 +203237,31 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"
" + "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"
" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", "in": "body", - "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"
" + "description": "Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"
" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", "in": "body", - "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"
" + "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"
" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", "in": "body", - "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"
" + "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"
" }, { "type": "string or null", "name": "secret_scanning_push_protection_custom_link", "in": "body", - "description": "The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.
The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
If provided, the secret will be used as the key to generate the HMAC hex digest value in the X-Hub-Signature header.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
The events that trigger this webhook. A global webhook can be triggered by user and organization events. Default: user and organization.
This will trigger a ping event to be sent to the webhook.
", + "descriptionHTML": "This will trigger a ping event to be sent to the webhook.
", "statusCodes": [ { "httpStatusCode": "204", @@ -201914,6 +204159,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -201934,7 +204182,7 @@ } ], "previews": [], - "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", + "descriptionHTML": "Updates the distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the Create a team endpoint to create a team with LDAP mapping.
", "statusCodes": [ { "httpStatusCode": "200", @@ -202586,7 +204834,7 @@ "serverUrl": "http(s)://HOSTNAME", "verb": "get", "requestPath": "/manage/v1/config/nodes", - "title": "Get all GHES node metadata for all nodes", + "title": "Get GHES node metadata for all nodes", "category": "enterprise-admin", "subcategory": "manage-ghes", "parameters": [ @@ -202668,6 +204916,9 @@ "uuid": { "type": "string" }, + "replica": { + "type": "boolean" + }, "cluster_roles": { "type": "array", "items": { @@ -202700,7 +204951,7 @@ } ], "previews": [], - "descriptionHTML": "Get all node metadata for existing nodes in the current cluster. For more information, see \"About clustering.\"
", + "descriptionHTML": "Get node metadata for all configured nodes in the current cluster. For more information, see \"About clustering.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -202709,6 +204960,275 @@ { "httpStatusCode": "401", "description": "Unauthorized
" + }, + { + "httpStatusCode": "500", + "description": "Internal error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "get", + "requestPath": "/manage/v1/maintenance", + "title": "Get the status of maintenance mode", + "category": "enterprise-admin", + "subcategory": "manage-ghes", + "parameters": [ + { + "name": "uuid", + "description": "The UUID which identifies a node.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "cluster_roles", + "description": "The cluster roles from the cluster configuration file.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "status": "scheduled", + "scheduled_time": "2006-01-02T15:04:05+00:00", + "connection_services": [ + { + "name": "git operations", + "number": 15 + }, + { + "name": "mysql queries", + "number": 6 + }, + { + "name": "resque jobs", + "number": 10 + }, + { + "name": "aqueduct jobs", + "number": 0 + } + ], + "can_unset_maintenance": true, + "ip_exception_list": [ + "1.1.1.1" + ], + "maintenance_mode_message": "Scheduled maintenance for upgrading." + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname" + }, + "uuid": { + "type": "string", + "format": "uuid" + }, + "status": { + "type": "string", + "enum": [ + "on", + "off", + "scheduled" + ] + }, + "scheduled_time": { + "type": "string", + "format": "date" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "integer" + } + } + } + }, + "can_unset_maintenance": { + "type": "boolean" + }, + "ip_exception_list": { + "type": "array", + "items": { + "type": "string", + "format": "ip/cidr" + } + }, + "maintenance_mode_message": { + "type": "string" + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets the status and details of maintenance mode on all available nodes. For more information, see \"Enabling and scheduling maintenance mode.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Unauthorized
" + }, + { + "httpStatusCode": "500", + "description": "Internal error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME", + "verb": "post", + "requestPath": "/manage/v1/maintenance", + "title": "Set the status of maintenance mode", + "category": "enterprise-admin", + "subcategory": "manage-ghes", + "parameters": [], + "bodyParameters": [ + { + "type": "boolean", + "name": "enabled", + "in": "body", + "description": "Whether to enable maintenance mode.
", + "isRequired": true + }, + { + "type": "string", + "name": "uuid", + "in": "body", + "description": "The UUID of the node to target. This parameter is incompatible with maintenance mode scheduling. Only use uuid if the value of when is empty or now.
The time to enable maintenance mode. If this parameter is empty or set to now, maintenance mode is enabled immediately. Otherwise, maintenance mode is enabled at the specified time. The format is ISO 8601.
The list of IP addresses to exclude from maintenance mode. IPv4, IPv6, and CIDR addresses are supported.
" + }, + { + "type": "string", + "name": "maintenance_mode_message", + "in": "body", + "description": "The message to display to users when maintenance mode is enabled.
" + } + ], + "enabledForGitHubApps": false, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "enabled": true, + "when": "2006-01-02T15:04:05+00:00", + "ip_exception_list": [ + "192.168.1.0/24", + "1.1.1.1" + ] + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "hostname": "ghe-local-primary", + "uuid": "1b6cf518-f97c-11ed-8544-061d81f7eedb", + "message": "maintenance mode scheduled with exception list [1.1.1.1]" + } + ], + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hostname": { + "type": "string", + "format": "hostname" + }, + "uuid": { + "type": "string", + "format": "uuid" + }, + "message": { + "type": "string" + }, + "error": { + "type": "string" + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Sets or schedules the maintenance mode. For more information, see \"Enabling and scheduling maintenance mode.\"
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Unauthorized
" + }, + { + "httpStatusCode": "500", + "description": "Internal error
" } ] }, @@ -202878,6 +205398,10 @@ { "httpStatusCode": "401", "description": "Unauthorized
" + }, + { + "httpStatusCode": "500", + "description": "Internal error
" } ] }, @@ -202976,7 +205500,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"GitHub Enterprise Server releases.\"
", + "descriptionHTML": "Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see \"GitHub Enterprise Server releases.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -202985,6 +205509,10 @@ { "httpStatusCode": "401", "description": "Unauthorized
" + }, + { + "httpStatusCode": "500", + "description": "Internal error
" } ] } @@ -203954,7 +206482,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote: You cannot retrieve the management console password with the Enterprise administration API.
", + "descriptionHTML": "Gets the settings for your instance. To change settings, see the Set settings endpoint.
\nNote: You cannot retrieve the management console password with the Enterprise administration API.
", "statusCodes": [ { "httpStatusCode": "200", @@ -203979,7 +206507,7 @@ "type": "string", "name": "settings", "in": "body", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.
", + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the Get settings endpoint.
", "isRequired": true } ], @@ -204002,7 +206530,7 @@ } ], "previews": [], - "descriptionHTML": "Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"Applies settings on your instance. For a list of the available settings, see the Get settings endpoint.
\nNotes:
\napplication/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.ghe-set-password utility to change the management console password. For more information, see \"Command-line utilities.\"An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.
" + "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the Get settings endpoint.
" } ], "enabledForGitHubApps": false, @@ -204282,7 +206810,7 @@ } ], "previews": [], - "descriptionHTML": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.
\nNote that you need to POST to /setup/api/configure to start the actual configuration process.
When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:
\nNote: The request body for this operation must be submitted as multipart/form-data data. You can can reference the license file by prefixing the filename with the @ symbol using curl. For more information, see the curl documentation.
Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"
" + "description": "Required for built-in authentication. The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"About authentication for your enterprise.\"
" }, { "type": "boolean", @@ -213649,7 +216177,7 @@ } ], "previews": [], - "descriptionHTML": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.
If the login name or email address is already associated with an account, the server will return a 422 response.
If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.
If the login name or email address is already associated with an account, the server will return a 422 response.
Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
\nYou can delete any user account except your own.
", + "descriptionHTML": "Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
\nYou can delete any user account except your own.
", "statusCodes": [ { "httpStatusCode": "204", @@ -213798,7 +216326,7 @@ "type": "array of strings", "name": "scopes", "in": "body", - "description": "A list of scopes.
", + "description": "A list of scopes.
", "isRequired": true } ], @@ -215548,7 +218076,7 @@ } ], "previews": [], - "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
The reason the user is being suspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Suspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
\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.\"
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
\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.\"
The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
The reason the user is being unsuspended. This message will be logged in the audit log. If you don't provide a reason, it will default to \"Unsuspended via API by SITE_ADMINISTRATOR\", where SITE_ADMINISTRATOR is the person who performed the action.
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
List public gists sorted by most recently updated to least recently updated.
\nNote: With 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.
", + "descriptionHTML": "List public gists sorted by most recently updated to least recently updated.
\nNote: With 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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -226314,7 +228842,7 @@ } ], "previews": [], - "descriptionHTML": "Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
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 to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\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.
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.
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 to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".
\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.
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request 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\".
", + "descriptionHTML": "Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.
Note: You need to explicitly request 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\".
", "statusCodes": [ { "httpStatusCode": "200", @@ -231547,7 +234075,7 @@ } ], "previews": [], - "descriptionHTML": "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 the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
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 the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
\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:
| Name | Type | Description |
|---|---|---|
verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. |
reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. |
signature | string | The signature that was extracted from the commit. |
payload | string | The value that was signed. |
These are the possible values for reason in the verification object:
| Value | Description |
|---|---|
expired_key | The key that made the signature is expired. |
not_signing_key | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |
gpgverify_error | There was an error communicating with the signature verification service. |
gpgverify_unavailable | The signature verification service is currently unavailable. |
unsigned | The object does not include a signature. |
unknown_signature_type | A non-PGP signature was found in the commit. |
no_user | No user was associated with the committer email address in the commit. |
unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. |
bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. |
unknown_key | The key that made the signature has not been registered with any user's account. |
malformed_signature | There was an error parsing the signature. |
invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |
valid | None of the above errors applied, so the signature is considered to be verified. |
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.
\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\" and \"Update a reference.\"
\nReturns an error if you try to delete a file that does not exist.
", + "descriptionHTML": "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.
\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\" and \"Update a reference.\"
\nReturns an error if you try to delete a file that does not exist.
", "statusCodes": [ { "httpStatusCode": "201", @@ -232055,13 +234583,13 @@ }, { "name": "tree_sha", + "description": "The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -232369,7 +234897,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
List all templates available to pass as an option when creating a repository.
", + "descriptionHTML": "List all templates available to pass as an option when creating a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -232506,7 +235034,7 @@ } ], "previews": [], - "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", + "descriptionHTML": "The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.
", "statusCodes": [ { "httpStatusCode": "200", @@ -236047,7 +238575,7 @@ } ], "previews": [], - "descriptionHTML": "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.
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\" endpoint.
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.
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\" endpoint.
List issues in an organization assigned to the authenticated user.
\nNote: 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\" endpoint.
List issues in an organization assigned to the authenticated user.
\nNote: 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\" endpoint.
List issues in a repository. Only open issues will be listed.
\nNote: 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\" endpoint.
List issues in a repository. Only open issues will be listed.
\nNote: 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\" endpoint.
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -249729,7 +252257,7 @@ } ], "previews": [], - "descriptionHTML": "The API returns a 301 Moved Permanently status if the issue was\ntransferred 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 webhook.
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\" endpoint.
The API returns a 301 Moved Permanently status if the issue was\ntransferred 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 webhook.
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\" endpoint.
Users with push access can lock an issue or pull request's conversation.
\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.\"
Users with push access can lock an issue or pull request's conversation.
\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.\"
List issues across owned and member repositories assigned to the authenticated user.
\nNote: 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\" endpoint.
List issues across owned and member repositories assigned to the authenticated user.
\nNote: 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\" endpoint.
Lists the available assignees for issues in a repository.
", + "descriptionHTML": "Lists the available assignees for issues in a repository.
", "statusCodes": [ { "httpStatusCode": "200", @@ -267806,7 +270334,7 @@ } ], "previews": [], - "descriptionHTML": "You 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.
\nThis endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nSee \"Secondary rate limits\"\nand \"Dealing with secondary rate limits\"\nfor details.
", + "descriptionHTML": "You 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.
\nThis endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nSee \"Secondary rate limits\"\nand \"Dealing with secondary rate limits\"\nfor details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -272116,6 +274644,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -272232,6 +274763,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -277080,6 +279618,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -277196,6 +279737,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -283044,6 +285592,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -283160,6 +285711,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -284105,6 +286663,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -284221,6 +286782,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -288086,7 +290654,7 @@ "type": "array of strings", "name": "labels", "in": "body", - "description": "The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also replace all of the labels for an issue. For more information, see \"Set labels for an issue.\"
The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"
This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", + "descriptionHTML": "This method returns the contents of the repository's license file, if one is detected.
\nSimilar to Get repository content, this method also supports custom media types for retrieving the raw license content or rendered license HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -308329,7 +310917,7 @@ "*.example.com" ] }, - "installed_version": "3.9.0" + "installed_version": "3.10.0" }, "schema": { "title": "Api Overview", @@ -308404,7 +310992,7 @@ "installed_version": { "type": "string", "examples": [ - "3.9.0" + "3.10.0" ] } }, @@ -315487,7 +318075,7 @@ } ], "previews": [], - "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", + "descriptionHTML": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.
", "statusCodes": [ { "httpStatusCode": "204", @@ -316394,6 +318982,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -321402,6 +324004,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -321810,7 +324426,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the list your authorizations API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on the application authorizations settings screen within GitHub. The scopes returned are the union of scopes authorized for the application. For example, if an application has one token with repo scope and another token with user scope, the grant will return [\"repo\", \"user\"].
Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", @@ -322182,7 +324798,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on the application authorizations settings screen within GitHub.
", "statusCodes": [ { "httpStatusCode": "204", @@ -322257,7 +324873,7 @@ "url": "https://enterprise.octocat.com/api/v3/authorizations/2", "app": { "name": "My personal access token", - "url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens", + "url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens", "client_id": "00000000000000000000" }, "token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a", @@ -323074,7 +325690,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", @@ -323973,7 +326589,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates OAuth tokens using Basic Authentication. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use fingerprint to differentiate between them.
You can also create tokens on GitHub Enterprise Server from the personal access tokens settings page. Read more about these tokens in the GitHub Help documentation.
\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "201", @@ -324907,7 +327523,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "example": { "id": 1, "url": "https://api.github.com/authorizations/1", @@ -325715,7 +328331,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nDeprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nDeprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", @@ -325723,7 +328339,7 @@ }, { "httpStatusCode": "201", - "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
" + "description": "Deprecation Notice: GitHub will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
" }, { "httpStatusCode": "304", @@ -327462,7 +330078,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nWarning: Apps must use the web application flow to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the blog post.
\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. fingerprint is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -328319,7 +330935,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "200", @@ -329227,7 +331843,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"Working with two-factor authentication.\"
\nYou can only send one of these scope keys at a time.
", "statusCodes": [ { "httpStatusCode": "200", @@ -329276,7 +331892,7 @@ } ], "previews": [], - "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", + "descriptionHTML": "Deprecation Notice: GitHub Enterprise Server will discontinue the OAuth Authorizations API, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our web application flow. The OAuth Authorizations API will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the blog post.
", "statusCodes": [ { "httpStatusCode": "204", @@ -329462,7 +332078,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
Lists all organizations, in the order that they were created on GitHub Enterprise Server.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.
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.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
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.
GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"
Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_private_repositories", "in": "body", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "boolean", "name": "members_can_create_public_repositories", "in": "body", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.
" }, { "type": "string", @@ -330172,37 +332788,37 @@ "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", "in": "body", - "description": "Whether GitHub Advanced Security is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether GitHub Advanced Security is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot alerts is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot alerts is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot security updates is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether Dependabot security updates is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether dependency graph is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether dependency graph is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning push protection is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Whether secret scanning push protection is automatically enabled for new repositories.
\nTo use this parameter, 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.\"
\nYou can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.
Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service
", + "descriptionHTML": "Deletes an organization and all its repositories.
\nThe organization login will be unavailable for 90 days after deletion.
\nPlease review the Terms of Service regarding account deletion before using this endpoint:
\nhttps://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service
", "statusCodes": [ { "httpStatusCode": "202", @@ -330837,7 +333453,7 @@ }, { "name": "phrase", - "description": "A search phrase. For more information, see Searching the audit log.
", + "description": "A search phrase. For more information, see Searching the audit log.
", "in": "query", "required": false, "schema": { @@ -330860,7 +333476,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
", "in": "query", "required": false, "schema": { @@ -330869,7 +333485,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.
", "in": "query", "required": false, "schema": { @@ -331231,7 +333847,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nTo use this endpoint, you must be an organization owner, and you must use an access token with the read:audit_log scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", + "descriptionHTML": "Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"
\nTo use this endpoint, you must be an organization owner, and you must use an access token with the read:audit_log scope. GitHub Apps must have the organization_administration read permission to use this endpoint.
By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"
Use pagination to retrieve fewer or more than 30 events. For more information, see \"Resources in the REST API.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -332295,7 +334911,7 @@ } ], "previews": [], - "descriptionHTML": "Enables or disables the specified security feature for all eligible repositories in an organization.
\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.
\nGitHub Apps must have the organization_administration:write permission to use this endpoint.
For more information, see \"Managing security managers in your organization.\"
", + "descriptionHTML": "Enables or disables the specified security feature for all eligible repositories in an organization.
\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.
\nGitHub Apps must have the organization_administration:write permission to use this endpoint.
For more information, see \"Managing security managers in your organization.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -332663,7 +335279,7 @@ } ], "previews": [], - "descriptionHTML": "List public organization memberships for the specified user.
\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 API instead.
", + "descriptionHTML": "List public organization memberships for the specified user.
\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 API instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -332968,7 +335584,7 @@ } ], "previews": [], - "descriptionHTML": "Note: This operation is deprecated and will be removed in the future.\nUse the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "Note: This operation is deprecated and will be removed in the future.\nUse the \"List custom repository roles\" endpoint instead.
\nList the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -333318,7 +335934,7 @@ } ], "previews": [], - "descriptionHTML": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -333649,7 +336265,7 @@ } ], "previews": [], - "descriptionHTML": "Creates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint, the authenticated user must be an administrator for the organization and must use a personal access token (classic) with admin:org scope or a fine-grained personal access token with the organization_custom_roles:write organization permission.
For more information on custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "Creates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint, the authenticated user must be an administrator for the organization and must use a personal access token (classic) with admin:org scope or a fine-grained personal access token with the organization_custom_roles:write organization permission.
For more information on custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "201", @@ -333955,7 +336571,7 @@ } ], "previews": [], - "descriptionHTML": "Gets a custom repository role that is available to all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "Gets a custom repository role that is available to all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
For more information on custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -334298,7 +336914,7 @@ } ], "previews": [], - "descriptionHTML": "Updates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "Updates a custom repository role that can be used by all repositories owned by the organization.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -334361,7 +336977,7 @@ } ], "previews": [], - "descriptionHTML": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"About custom repository roles.\"
", + "descriptionHTML": "Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.
\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with admin:org scope.\nGitHub Apps must have the organization_custom_roles:write organization permission to use this endpoint.
For more information about custom repository roles, see \"About custom repository roles.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -334441,7 +337057,7 @@ } ], "previews": [], - "descriptionHTML": "Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"
\nTo use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the admin:org or repo scope.\nGitHub Apps must have the organization_custom_roles:read or organization_administration:read organization permission to use this endpoint.
Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.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
\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.
", + "descriptionHTML": "Only authenticated organization owners can add a member to the organization or update the member's role.
\npending until they accept the invitation.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
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -336159,7 +338775,7 @@ } ], "previews": [], - "descriptionHTML": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The user can publicize their own membership. (A user cannot publicize the membership for another user.)
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
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\". 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.\"
", + "descriptionHTML": "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\". 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.\"
", "statusCodes": [ { "httpStatusCode": "202", @@ -337950,7 +340566,7 @@ }, { "httpStatusCode": "403", - "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"
" }, { "httpStatusCode": "404", @@ -338018,6 +340634,3310 @@ ] } ], + "personal-access-tokens": [ + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/personal-access-token-requests", + "title": "List requests to access organization resources with fine-grained personal access tokens", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": [ + { + "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 + } + ], + "schema": { + "type": "array", + "items": { + "title": "Simple Organization Programmatic Access Grant Request", + "description": "Minimal representation of an organization programmatic access grant request for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests." + }, + "reason": { + "type": [ + "string", + "null" + ], + "description": "Reason for requesting access." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "created_at": { + "type": "string", + "description": "Date and time when the request for access was created." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "reason", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "created_at", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/personal-access-token-requests", + "title": "Review requests to access organization resources with fine-grained personal access tokens", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "pat_request_ids", + "in": "body", + "description": "Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 pat_request_id values.
Action to apply to the requests.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the requests. Max 1024 characters.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of denying a request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "pat_request_ids": [ + 42, + 73 + ], + "action": "deny", + "reason": "Access is too broad." + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}", + "title": "Review a request to access organization resources with a fine-grained personal access token", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the request.
", + "isRequired": true, + "enum": [ + "approve", + "deny" + ] + }, + { + "type": "string or null", + "name": "reason", + "in": "body", + "description": "Reason for approving or denying the request. Max 1024 characters.
" + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of denying a request", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "deny", + "reason": "This request is denied because the access is too broad." + }, + "parameters": { + "org": "ORG", + "pat_request_id": "PAT_REQUEST_ID" + } + }, + "response": { + "statusCode": "204", + "description": "A header with no content is returned.
" + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories", + "title": "List repositories requested to be accessed by a fine-grained personal access token", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_request_id", + "in": "path", + "description": "Unique identifier of the request for access via fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "pat_request_id": "PAT_REQUEST_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/personal-access-tokens", + "title": "List fine-grained personal access tokens with access to organization resources", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "sort", + "description": "The property by which to sort the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created_at" + ], + "default": "created_at" + } + }, + { + "name": "direction", + "description": "The direction to sort the results by.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "owner", + "description": "A list of owner usernames to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "array", + "maxItems": 10, + "items": { + "type": "string" + }, + "examples": [ + "owner[]=octocat1,owner[]=octocat2" + ] + } + }, + { + "name": "repository", + "description": "The name of the repository to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "Hello-World" + ] + } + }, + { + "name": "permission", + "description": "The permission to use to filter the results.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "examples": [ + "issues_read" + ] + } + }, + { + "name": "last_used_before", + "description": "Only show fine-grained personal access tokens used before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Only show fine-grained personal access tokens used after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Response
", + "example": [ + { + "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 + } + ], + "schema": { + "type": "array", + "items": { + "title": "Organization Programmatic Access Grant", + "description": "Minimal representation of an organization programmatic access grant for enumerations", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token." + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "repository_selection": { + "type": "string", + "enum": [ + "none", + "all", + "subset" + ], + "description": "Type of repository selection requested." + }, + "repositories_url": { + "type": "string", + "description": "URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`." + }, + "permissions": { + "type": "object", + "description": "Permissions requested, categorized by type of permission.", + "properties": { + "organization": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "repository": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "other": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "access_granted_at": { + "type": "string", + "description": "Date and time when the fine-grained personal access token was approved to access the organization." + }, + "token_expired": { + "type": "boolean", + "description": "Whether the associated fine-grained personal access token has expired." + }, + "token_expires_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token expires." + }, + "token_last_used_at": { + "type": [ + "string", + "null" + ], + "description": "Date and time when the associated fine-grained personal access token was last used for authentication." + } + }, + "required": [ + "id", + "owner", + "repository_selection", + "repositories_url", + "permissions", + "access_granted_at", + "token_expired", + "token_expires_at", + "token_last_used_at" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/personal-access-tokens", + "title": "Update the access to organization resources via fine-grained personal access tokens", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the fine-grained personal access token.
", + "isRequired": true, + "enum": [ + "revoke" + ] + }, + { + "type": "array of integers", + "name": "pat_ids", + "in": "body", + "description": "The IDs of the fine-grained personal access tokens.
", + "isRequired": true + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of revoking a fine-grained personal access token.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "revoke", + "pat_ids": [ + 1296269, + 1296280 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "202", + "contentType": "application/json", + "description": "Accepted
", + "example": null, + "schema": { + "type": "object" + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "202", + "description": "Accepted
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "post", + "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}", + "title": "Update the access a fine-grained personal access token has to organization resources", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "description": "The unique identifier of the fine-grained personal access token.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "Action to apply to the fine-grained personal access token.
", + "isRequired": true, + "enum": [ + "revoke" + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example of revoking a fine-grained personal access token.", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "action": "revoke" + }, + "parameters": { + "org": "ORG", + "pat_id": "PAT_ID" + } + }, + "response": { + "statusCode": "204", + "description": "A header with no content is returned.
" + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "A header with no content is returned.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "http(s)://HOSTNAME/api/v3", + "verb": "get", + "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories", + "title": "List repositories a fine-grained personal access token has access to", + "category": "orgs", + "subcategory": "personal-access-tokens", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "pat_id", + "in": "path", + "description": "Unique identifier of the fine-grained personal access token.
", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "pat_id": "PAT_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "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": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "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 + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + } + } + } + ], + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n[version]: http://contributor-covenant.org/version/1/4/\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + } + ], + "previews": [], + "descriptionHTML": "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.
Note: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + } + ], "security-managers": [ { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -338063,6 +343983,7 @@ "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", @@ -338134,6 +344055,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -338180,7 +344108,7 @@ } ], "previews": [], - "descriptionHTML": "Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\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.
GitHub Apps must have the administration organization read permission to use this endpoint.
Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"
\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.
GitHub Apps must have the administration organization read permission to use this endpoint.
Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
Adds a team as a security manager for an organization. For more information, see \"Managing security for an organization for an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
Removes the security manager role from a team for an organization. For more information, see \"Managing security managers in your organization team from an organization.\"
\nTo use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org scope.
GitHub Apps must have the administration organization read-write permission to use this endpoint.
Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "isRequired": true, "childParamsGroups": [ { @@ -338557,7 +344485,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.
Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.
Returns a webhook configured in an organization. To get only the webhook config properties, see \"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.\"
Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -339015,7 +344943,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for.
", + "description": "Determines what events the hook is triggered for.
", "default": [ "push" ] @@ -339206,7 +345134,7 @@ } ], "previews": [], - "descriptionHTML": "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.\"
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.\"
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 .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
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 .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
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 .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
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 .\"
Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.
This will trigger a ping event to be sent to the hook.
", + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", @@ -341225,6 +347153,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -341381,7 +347323,7 @@ }, { "name": "visibility", - "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
Lists packages in an organization readable by the user.
\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.\"
Lists packages in an organization readable by the user.
\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.\"
Gets a specific package in an organization.
\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.\"
Gets a specific package in an organization.
\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.\"
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.
\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:
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.\"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.\"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.
\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:
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.\"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.\"Restores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\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:
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.\"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.\"Restores an entire package in an organization.
\nYou can restore a deleted package under the following conditions:
\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:
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.\"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.\"Lists package versions for a package owned by an organization.
\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.\"
Lists package versions for a package owned by an organization.
\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.\"
Gets a specific package version in an organization.
\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.\"
Gets a specific package version in an organization.
\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.\"
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.
\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:
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.\"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.\"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.
\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:
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.\"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.\"Restores a specific package version in an organization.
\nYou can restore a deleted package under the following conditions:
\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:
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.\"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.\"Restores a specific package version in an organization.
\nYou can restore a deleted package under the following conditions:
\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:
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.\"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.\"The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
Lists packages owned by the authenticated user within the user's namespace.
\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.\"
Lists packages owned by the authenticated user within the user's namespace.
\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.\"
Gets a specific package for a package owned by the authenticated user.
\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.\"
Gets a specific package for a package owned by the authenticated user.
\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.\"
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.
\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.\"
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.
\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.\"
Restores a package owned by the authenticated user.
\nYou can restore a deleted package under the following conditions:
\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.\"
Restores a package owned by the authenticated user.
\nYou can restore a deleted package under the following conditions:
\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.\"
Lists package versions for a package owned by the authenticated user.
\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.\"
Lists package versions for a package owned by the authenticated user.
\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.\"
Gets a specific package version for a package owned by the authenticated user.
\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.\"
Gets a specific package version for a package owned by the authenticated user.
\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.\"
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.
\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.\"
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.
\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.\"
Restores a package version owned by the authenticated user.
\nYou can restore a deleted package version under the following conditions:
\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.\"
Restores a package version owned by the authenticated user.
\nYou can restore a deleted package version under the following conditions:
\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.\"
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
The selected visibility of the packages. This parameter is optional and only filters an existing result set.
\nThe internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"
Lists all packages in a user's namespace for which the requesting user has access.
\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.\"
Lists all packages in a user's namespace for which the requesting user has access.
\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.\"
Gets a specific package metadata for a public package owned by a user.
\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.\"
Gets a specific package metadata for a public package owned by a user.
\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.\"
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.
\nTo use this endpoint, you must authenticate using an access token with the read:packages and delete:packages scopes. In addition:
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.\"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.\"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.
\nTo use this endpoint, you must authenticate using an access token with the read:packages and delete:packages scopes. In addition:
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.\"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.\"Restores an entire package for a user.
\nYou can restore a deleted package under the following conditions:
\nTo use this endpoint, you must authenticate using an access token with the read:packages and write:packages scopes. In addition:
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.\"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.\"Restores an entire package for a user.
\nYou can restore a deleted package under the following conditions:
\nTo use this endpoint, you must authenticate using an access token with the read:packages and write:packages scopes. In addition:
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.\"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.\"Lists package versions for a public package owned by a specified user.
\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.\"
Lists package versions for a public package owned by a specified user.
\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.\"
Gets a specific package version for a public package owned by a specified user.
\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.\"
Gets a specific package version for a public package owned by a specified user.
\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.\"
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.
\nTo use this endpoint, you must authenticate using an access token with the read:packages and delete:packages scopes. In addition:
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.\"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.\"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.
\nTo use this endpoint, you must authenticate using an access token with the read:packages and delete:packages scopes. In addition:
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.\"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.\"Restores a specific package version for a user.
\nYou can restore a deleted package under the following conditions:
\nTo use this endpoint, you must authenticate using an access token with the read:packages and write:packages scopes. In addition:
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.\"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.\"Restores a specific package version for a user.
\nYou can restore a deleted package under the following conditions:
\nTo use this endpoint, you must authenticate using an access token with the read:packages and write:packages scopes. In addition:
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.\"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.\"Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"
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 in the GitHub Help documentation.
", + "descriptionHTML": "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 in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -367742,13 +373807,13 @@ "type": "boolean", "name": "maintainer_can_modify", "in": "body", - "description": "Indicates whether maintainers can modify the pull request.
" + "description": "Indicates whether maintainers can modify the pull request.
" }, { "type": "boolean", "name": "draft", "in": "body", - "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
" + "description": "Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.
" }, { "type": "integer", @@ -367966,6 +374031,7 @@ "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" @@ -368281,6 +374347,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false, "merged": false, "mergeable": true, @@ -369579,6 +375646,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -371529,7 +377603,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -371598,7 +377672,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Pass the appropriate media type to fetch diff and patch formats.
", + "description": "Pass the appropriate media type to fetch diff and patch formats.
", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -371785,6 +377859,7 @@ "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" @@ -372100,6 +378175,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false, "merged": false, "mergeable": true, @@ -373398,6 +379474,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -375348,11 +381431,11 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server 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\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server 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.
The 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:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\nLists details of a pull request by providing its number.
\nWhen you get, create, or edit a pull request, GitHub Enterprise Server 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\".
The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Server 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.
The 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:
merge_commit_sha represents the SHA of the merge commit.merge_commit_sha represents the SHA of the squashed commit on the base branch.merge_commit_sha represents the commit that the base branch was updated to.Pass the appropriate media type to fetch diff and patch formats.
", "statusCodes": [ { "httpStatusCode": "200", - "description": "Pass the appropriate media type to fetch diff and patch formats.
" + "description": "Pass the appropriate media type to fetch diff and patch formats.
" }, { "httpStatusCode": "304", @@ -375441,7 +381524,7 @@ "type": "boolean", "name": "maintainer_can_modify", "in": "body", - "description": "Indicates whether maintainers can modify the pull request.
" + "description": "Indicates whether maintainers can modify the pull request.
" } ], "enabledForGitHubApps": true, @@ -375654,6 +381737,7 @@ "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" @@ -375969,6 +382053,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false, "merged": false, "mergeable": true, @@ -377267,6 +383352,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -379217,7 +385309,7 @@ } ], "previews": [], - "descriptionHTML": "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 in the GitHub Help documentation.
\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.
", + "descriptionHTML": "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 in the GitHub Help documentation.
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -380072,7 +386164,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
", + "descriptionHTML": "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 endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -380477,7 +386569,7 @@ } ], "previews": [], - "descriptionHTML": "Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "200", @@ -380546,7 +386638,7 @@ "type": "string", "name": "expected_head_sha", "in": "body", - "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\" 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\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.
The level at which the comment is targeted.
", "enum": [ - "LINE", - "FILE" + "line", + "file" ] } ], @@ -383996,7 +390088,7 @@ } ], "previews": [], - "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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.
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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"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.
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.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -384649,7 +390741,7 @@ } ], "previews": [], - "descriptionHTML": "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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -384750,6 +390842,7 @@ "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", @@ -384954,6 +391047,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -385070,6 +391166,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -385139,7 +391242,7 @@ } ], "previews": [], - "descriptionHTML": "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 operation.
", + "descriptionHTML": "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 operation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -385451,6 +391554,7 @@ "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", @@ -385780,6 +391884,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false }, "schema": { @@ -387007,6 +393112,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -387123,6 +393231,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -390875,7 +396990,7 @@ } ], "previews": [], - "descriptionHTML": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -391156,6 +397271,7 @@ "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", @@ -391258,6 +397374,7 @@ "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, @@ -391288,6 +397405,7 @@ "pull": true }, "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, @@ -391404,6 +397522,7 @@ "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, @@ -391434,6 +397553,7 @@ "pull": true }, "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, @@ -391481,6 +397601,7 @@ } }, "author_association": "OWNER", + "auto_merge": null, "draft": false }, "schema": { @@ -392708,6 +398829,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -392824,6 +398948,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -397067,7 +403198,7 @@ "type": "string", "name": "event", "in": "body", - "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 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 when you are ready.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\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.\"
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. To see a pull request diff, add this media type to the Accept header of a call to the single 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.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\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.\"
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. To see a pull request diff, add this media type to the Accept header of a call to the single 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.
Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", + "descriptionHTML": "Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.
", "statusCodes": [ { "httpStatusCode": "200", @@ -400267,7 +406398,7 @@ } ], "previews": [], - "descriptionHTML": "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.\"
", + "descriptionHTML": "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.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -400682,7 +406813,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -400990,7 +407121,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
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.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
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.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -401598,7 +407729,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. 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.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. 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.
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. OAuth access tokens require the write:discussion scope.
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. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -402039,7 +408170,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
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.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
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.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -402636,7 +408767,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. 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.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. 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.
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. OAuth access tokens require the write:discussion scope.
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. OAuth access tokens require the write:discussion scope.
Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
", "in": "query", "required": false, "schema": { @@ -403067,7 +409198,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a commit comment.
", + "descriptionHTML": "List the reactions to a commit comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -403120,7 +409251,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the commit comment.
", + "description": "The reaction type to add to the commit comment.
", "isRequired": true, "enum": [ "+1", @@ -403668,7 +409799,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a commit comment. 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. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -403796,7 +409927,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
", "in": "query", "required": false, "schema": { @@ -404103,7 +410234,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue comment.
", + "descriptionHTML": "List the reactions to an issue comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -404156,7 +410287,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue comment.
", + "description": "The reaction type to add to the issue comment.
", "isRequired": true, "enum": [ "+1", @@ -404704,7 +410835,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue comment. 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. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -404832,7 +410963,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to an issue.
", "in": "query", "required": false, "schema": { @@ -405139,7 +411270,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to an issue.
", + "descriptionHTML": "List the reactions to an issue.
", "statusCodes": [ { "httpStatusCode": "200", @@ -405196,7 +411327,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the issue.
", + "description": "The reaction type to add to the issue.
", "isRequired": true, "enum": [ "+1", @@ -405744,7 +411875,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -405872,7 +412003,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
", "in": "query", "required": false, "schema": { @@ -406179,7 +412310,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a pull request review comment.
", + "descriptionHTML": "List the reactions to a pull request review comment.
", "statusCodes": [ { "httpStatusCode": "200", @@ -406232,7 +412363,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the pull request review comment.
", + "description": "The reaction type to add to the pull request review comment.
", "isRequired": true, "enum": [ "+1", @@ -406780,7 +412911,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a pull request review comment. 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. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -406908,7 +413039,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a release.
", "in": "query", "required": false, "schema": { @@ -407213,7 +413344,7 @@ } ], "previews": [], - "descriptionHTML": "List the reactions to a release.
", + "descriptionHTML": "List the reactions to a release.
", "statusCodes": [ { "httpStatusCode": "200", @@ -407266,7 +413397,7 @@ "type": "string", "name": "content", "in": "body", - "description": "The reaction type to add to the release.
", + "description": "The reaction type to add to the release.
", "isRequired": true, "enum": [ "+1", @@ -407812,7 +413943,7 @@ } ], "previews": [], - "descriptionHTML": "Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.
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.
", + "descriptionHTML": "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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -407940,7 +414071,7 @@ }, { "name": "content", - "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
", "in": "query", "required": false, "schema": { @@ -408247,7 +414378,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
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 endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion comment.
", + "description": "The reaction type to add to the team discussion comment.
", "isRequired": true, "enum": [ "+1", @@ -408579,7 +414710,7 @@ } ], "previews": [], - "descriptionHTML": "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\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
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\" endpoint.
\nCreate a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.
Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", + "description": "Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
", "in": "query", "required": false, "schema": { @@ -408921,7 +415052,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
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 endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.
The reaction type to add to the team discussion.
", + "description": "The reaction type to add to the team discussion.
", "isRequired": true, "enum": [ "+1", @@ -409243,7 +415374,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
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 endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with an HTTP 200 status means that you already added the reaction type to this team discussion.
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.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", + "descriptionHTML": "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.
\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.
", "statusCodes": [ { "httpStatusCode": "200", @@ -410756,7 +416887,7 @@ } ], "previews": [], - "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "Users with push access to the repository can create a release.
\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -410875,7 +417006,7 @@ } ], "previews": [], - "descriptionHTML": "Generate a name and body describing 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.
", + "descriptionHTML": "Generate a name and body describing 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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -412369,7 +418500,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource.
To download the asset's binary content, set the Accept header of the request to application/octet-stream. 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.
To download the asset's binary content, set the Accept header of the request to application/octet-stream. 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.
This endpoint makes use of a Hypermedia relation 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 to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\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. For example:
application/zip
GitHub Enterprise Server 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.
\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.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. This endpoint makes use of a Hypermedia relation 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 to upload a release asset.
You need to use an HTTP client which supports SNI to make calls to this endpoint.
\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. For example:
application/zip
GitHub Enterprise Server 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.
\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.
Notes:
\nrelease_id query the GET /repos/{owner}/{repo}/releases/latest endpoint. Lists repositories for the specified organization.
\nNote: 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.\"
Lists repositories for the specified organization.
\nNote: 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.\"
The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.
The visibility of the repository. Note: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.
Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".
Creates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreates a new repository in the specified organization. The authenticated user must be a member of the organization.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryThe 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.
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.\"
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.
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.\"
Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.
Specify which security and analysis features to enable or disable for the repository.
\nTo use this parameter, 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.\"
\nFor example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.
You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
Specify which security and analysis features to enable or disable for the repository.
\nTo use this parameter, 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.\"
\nFor example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.
You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.
Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", + "descriptionHTML": "Note: To edit a repository's topics, use the Replace all repository topics endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -430836,8 +437009,8 @@ } ], "previews": [ - "You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.nebula-preview+jsonThe is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+jsonYou can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.
To access repository visibility during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.nebula-preview+json\nThe is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+json\nThe account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
Response if dependabot is enabled
", + "example": { + "enabled": true, + "paused": false + }, + "schema": { + "title": "Check Automated Security Fixes", + "description": "Check Automated Security Fixes", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether automated security fixes are enabled for the repository.", + "examples": [ + true + ] + }, + "paused": { + "type": "boolean", + "description": "Whether automated security fixes are paused for the repository.", + "examples": [ + false + ] + } + }, + "required": [ + "enabled", + "paused" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "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\".
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Response if dependabot is enabled
" + }, + { + "httpStatusCode": "404", + "description": "Not Found if dependabot is not enabled for the repository
" + } + ] + }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -431063,7 +437325,7 @@ } ], "previews": [], - "descriptionHTML": "List any syntax errors that are detected in the CODEOWNERS\nfile.
\nFor more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"
", + "descriptionHTML": "List any syntax errors that are detected in the CODEOWNERS\nfile.
\nFor more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -431350,7 +437612,7 @@ } ], "previews": [], - "descriptionHTML": "You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server 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.\"
The 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.
This endpoint requires write access to the repository by providing either:
\nrepo scope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation.metadata:read and contents:read&write permissions.This input example shows how you can use the client_payload as a test to debug your workflow.
You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Server 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.\"
The 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.
This endpoint requires write access to the repository by providing either:
\nrepo scope. For more information, see \"Creating a personal access token for the command line\" in the GitHub Help documentation.metadata:read and contents:read&write permissions.This input example shows how you can use the client_payload as a test to debug your workflow.
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.
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.\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.
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\".
", + "descriptionHTML": "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\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -433433,7 +439720,7 @@ } ], "previews": [], - "descriptionHTML": "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\".
", + "descriptionHTML": "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\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -433488,7 +439775,7 @@ } ], "previews": [], - "descriptionHTML": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
", + "descriptionHTML": "Disables dependency alerts for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -435170,7 +441457,7 @@ } } ], - "descriptionHTML": "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 endpoint and check that the is_template key is true.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreates 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 endpoint and check that the is_template key is true.
OAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repositoryCreating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+jsonCreating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.baptiste-preview+json\nLists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Lists all public repositories in the order that they were created.
\nNote:
\nsince parameter. Use the Link header to get the URL for the next page of repositories.Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repository.Creates a new repository for the authenticated user.
\nOAuth scope requirements
\nWhen using OAuth, authorizations must include:
\npublic_repo scope or repo scope to create a public repository. Note: For GitHub AE, use repo scope to create an internal repository.repo scope to create a private repository.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.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload 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.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types 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.
\nIf 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\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\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.
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.
If 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.
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.
Files and symlinks support a custom media type for\nretrieving the raw content or rendered HTML (when supported). All content types support a custom media\ntype to ensure the content is returned in a consistent\nobject format.
\nNotes:
\nTo get a repository's contents recursively, you can recursively get the tree.
\nThis API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees\nAPI.
\nDownload 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.\nSize limits:\nIf the requested file's size is:
\n1 MB or smaller: All features of this endpoint are supported.
\nBetween 1-100 MB: Only the raw or object custom media types 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.
\nIf 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\nshould be \"submodule\". This behavior exists in API v3 for backwards compatibility purposes.\nIn the next major version of the API, the type will be returned as \"submodule\".
\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.
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.
If 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.
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.
Note: If you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", + "descriptionHTML": "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.
Note: If you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -444389,7 +450704,7 @@ } ], "previews": [], - "descriptionHTML": "Deletes a file in a repository.
\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.
The 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.
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\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", + "descriptionHTML": "Deletes a file in a repository.
\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.
The 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.
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\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
", "statusCodes": [ { "httpStatusCode": "200", @@ -444598,7 +450913,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the preferred README for a repository.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -444810,7 +451125,7 @@ } ], "previews": [], - "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", + "descriptionHTML": "Gets the README from a repository directory.
\nREADMEs support custom media types for retrieving the raw content or rendered HTML.
", "statusCodes": [ { "httpStatusCode": "200", @@ -445870,6 +452185,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -452028,6 +458357,20 @@ } } }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning": { "type": "object", "properties": { @@ -452604,7 +458947,7 @@ "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -452613,7 +458956,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match
Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: best match
Searches for query terms inside of a file. This method returns up to 100 results per page.
\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.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
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:
\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.Searches for query terms inside of a file. This method returns up to 100 results per page.
\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.
For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:
q=addClass+in:file+language:js+repo:jquery/jquery
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:
\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:
\nmaster branch.language:go is not valid, while amazing language:go is.The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -453712,7 +460069,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by author-date or committer-date. Default: best match
Sorts the results of your query by author-date or committer-date. Default: best match
Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
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\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.
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\nmetadata.
For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:
\nq=repo:octocat/Spoon-Knife+css
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -455161,7 +461532,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
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
Find issues by state and keyword. This method returns up to 100 results per page.
\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.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
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 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.\"
Find issues by state and keyword. This method returns up to 100 results per page.
\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.
For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.
\nq=windows+label:bug+language:python+state:open&sort=created&order=asc
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 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.\"
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.
", + "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.
", "in": "query", "required": true, "schema": { @@ -458330,7 +464701,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by when the label was created or updated. Default: best match
Sorts the results of your query by when the label was created or updated. Default: best match
Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\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.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", + "descriptionHTML": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.
\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.
For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:
q=bug+defect+enhancement&repository_id=64778136
The labels that best match the query appear first in the search results.
", "statusCodes": [ { "httpStatusCode": "200", @@ -458556,7 +464927,7 @@ "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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -458565,7 +464936,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
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
Find repositories via various criteria. This method returns up to 100 results per page.
\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.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This 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.
Find repositories via various criteria. This method returns up to 100 results per page.
\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.
For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:
\nq=tetris+language:assembly&sort=stars&order=desc
This 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.
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see 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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query.
", "in": "query", "required": true, "schema": { @@ -459788,7 +466159,7 @@ } ], "previews": [], - "descriptionHTML": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\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.
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:
\nq=ruby+is:featured
This 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.
Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.
\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.
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:
\nq=ruby+is:featured
This 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.
The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"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 Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.
", "in": "query", "required": true, "schema": { @@ -459819,7 +466190,7 @@ }, { "name": "sort", - "description": "Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match
Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Server. Default: best match
Find users via various criteria. This method returns up to 100 results per page.
\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. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=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.\"
", + "descriptionHTML": "Find users via various criteria. This method returns up to 100 results per page.
\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. For more details about how to receive highlighted search results, see Text match metadata.
For example, if you're looking for a list of popular users, you might try this query:
\nq=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.\"
", "statusCodes": [ { "httpStatusCode": "200", @@ -460191,7 +466562,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -460245,7 +466616,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor.
", "in": "query", "required": false, "schema": { @@ -460254,7 +466625,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor.
", "in": "query", "required": false, "schema": { @@ -460738,7 +467109,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", @@ -461484,7 +467855,7 @@ } ], "previews": [], - "descriptionHTML": "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.
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.
A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -461596,7 +467967,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -461605,7 +467976,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -462089,7 +468460,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", @@ -462893,7 +469264,7 @@ { "name": "secret_type", "in": "query", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", + "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"Secret scanning patterns\"\nfor a complete list of secret types.
", "required": false, "schema": { "type": "string" @@ -462956,7 +469327,7 @@ }, { "name": "before", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.
", "in": "query", "required": false, "schema": { @@ -462965,7 +469336,7 @@ }, { "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", + "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.
", "in": "query", "required": false, "schema": { @@ -463323,7 +469694,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", @@ -463864,7 +470235,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", @@ -464463,7 +470834,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"" }, "secret": { "type": "string", @@ -465019,6 +471390,7 @@ "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", @@ -465053,6 +471425,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -465169,6 +471544,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -465298,6 +471680,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen. The options are:
\nnotifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.notifications_enabledThe distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"
" + "description": "The distinguished name (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"Update LDAP mapping for a team\" endpoint to change the LDAP DN. For more information, see \"Using LDAP.\"
" } ], "enabledForGitHubApps": true, @@ -465334,6 +471726,7 @@ "name": "Justice League", "description": "A great team", "permission": "push", + "notification_setting": "notifications_enabled", "privacy": "closed" }, "parameters": { @@ -465353,6 +471746,7 @@ "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", @@ -465457,6 +471851,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -465545,6 +471950,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -466016,7 +472428,7 @@ } ], "previews": [], - "descriptionHTML": "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.\"
When 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\".
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.\"
When 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\".
The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
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.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
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}.
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.
You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.
If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.
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}.
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.\"
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}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", + "descriptionHTML": "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.\"
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}.
For more information about the permission levels, see \"Repository permission levels for an organization\".
", "statusCodes": [ { "httpStatusCode": "204", @@ -473086,6 +479581,7 @@ "slug": "original-roster", "description": "Started it all.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", @@ -473098,6 +479594,7 @@ "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" @@ -473133,6 +479630,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -473249,6 +479749,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -473363,6 +479870,7 @@ "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", @@ -473467,6 +479975,17 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ], + "examples": [ + "notifications_enabled" + ] + }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", @@ -473555,6 +480074,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -474026,7 +480552,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
", + "descriptionHTML": "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 endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -474080,6 +480606,16 @@ "closed" ] }, + { + "type": "string", + "name": "notification_setting", + "in": "body", + "description": "The notification setting the team has chosen. Editing teams without specifying this parameter leaves notification_setting intact. The options are:
notifications_enabled - team members receive notifications when the team is @mentioned. notifications_disabled - no one receives notifications.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 endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
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 endpoint.
\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.
\nNote: With nested teams, the privacy for parent teams cannot be secret.
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 endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", + "descriptionHTML": "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 endpoint.
\nTo delete a team, the authenticated user must be an organization owner or team maintainer.
\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.
", "statusCodes": [ { "httpStatusCode": "204", @@ -475910,7 +482486,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
Lists the organization projects for a team.
", + "descriptionHTML": "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 endpoint.
Lists the organization projects for a team.
", "statusCodes": [ { "httpStatusCode": "200", @@ -476261,7 +482837,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
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 endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP verbs.\"
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 endpoint.
\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.
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 endpoint.
\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.
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 endpoint.
\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.
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 endpoint.
\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.
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 endpoint.
", + "descriptionHTML": "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 endpoint.
", "statusCodes": [ { "httpStatusCode": "200", @@ -480067,7 +486657,7 @@ } ], "previews": [], - "descriptionHTML": "Note: Repositories inherited through a parent team will also be checked.
\nDeprecation 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 endpoint.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
Note: Repositories inherited through a parent team will also be checked.
\nDeprecation 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 endpoint.
\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:
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\" endpoint.
\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.
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.\"
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\" endpoint.
\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.
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.\"
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 endpoint.
\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.
", + "descriptionHTML": "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 endpoint.
\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.
", "statusCodes": [ { "httpStatusCode": "204", @@ -480298,6 +486888,7 @@ "slug": "original-roster", "description": "Started it all.", "privacy": "closed", + "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/2/members{/member}", "repositories_url": "https://api.github.com/teams/2/repos", @@ -480310,6 +486901,7 @@ "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" @@ -480345,6 +486937,9 @@ "privacy": { "type": "string" }, + "notification_setting": { + "type": "string" + }, "permission": { "type": "string" }, @@ -480461,6 +487056,13 @@ "closed" ] }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, "html_url": { "type": "string", "format": "uri", @@ -480524,7 +487126,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
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 endpoint.
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 when authenticating via OAuth. When using a fine-grained personal access token, the resource owner of the token must be a single organization, 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.
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 when authenticating via OAuth. When using a fine-grained personal access token, the resource owner of the token must be a single organization, 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.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
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.
List all comments on a team discussion. OAuth access tokens require the read:discussion scope.
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.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: 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.
Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: 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.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
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}.
Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
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}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
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}.
Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
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}.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
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}.
Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
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}.
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 endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
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 endpoint.
\nList all comments on a team discussion. OAuth access tokens require the read:discussion scope.
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 endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "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 endpoint.
\nCreates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -484429,7 +491048,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
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 endpoint.
\nGet a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.
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 endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
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 endpoint.
\nEdits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.
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 endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
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 endpoint.
\nDeletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
\nNote: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
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}.
Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
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}.
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.
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}.
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.
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}.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
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}.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
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}.
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 endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
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 endpoint.
List all discussions on a team's page. OAuth access tokens require the read:discussion scope.
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 endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", + "descriptionHTML": "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 endpoint.
Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.
This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.
", "statusCodes": [ { "httpStatusCode": "201", @@ -488357,7 +494976,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
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 endpoint.
\nGet a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.
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 endpoint.
\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.
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 endpoint.
\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.
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 endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
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 endpoint.
Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.
Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "descriptionHTML": "Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -489241,7 +495860,7 @@ } ], "previews": [], - "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "descriptionHTML": "Lists external groups available in an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Server generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -489365,7 +495984,7 @@ } ], "previews": [], - "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "descriptionHTML": "Lists a connection between a team and an external group.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -489590,7 +496209,7 @@ } ], "previews": [], - "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", + "descriptionHTML": "Creates a connection between a team and an external group. Only one external group can be linked to a team.
\nYou can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "200", @@ -489645,7 +496264,7 @@ } ], "previews": [], - "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", + "descriptionHTML": "Deletes a connection between a team and an external group.
\nYou can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
", "statusCodes": [ { "httpStatusCode": "204", @@ -490029,7 +496648,7 @@ } ], "previews": [], - "descriptionHTML": "Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe 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.
Team members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.
Note:\nThe 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 Create a team.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\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.
\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.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\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.
\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.
\nNote: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.
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.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
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.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.
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 endpoint.
Team members will include the members of child teams.
", + "descriptionHTML": "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 endpoint.
Team members will include the members of child teams.
", "statusCodes": [ { "httpStatusCode": "200", @@ -490557,7 +497176,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", + "descriptionHTML": "The \"Get team member\" endpoint (described below) is deprecated.
\nWe recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.
\nTo list members in a team, the team must be visible to the authenticated user.
", "statusCodes": [ { "httpStatusCode": "204", @@ -490616,7 +497235,7 @@ } ], "previews": [], - "descriptionHTML": "The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The \"Add team member\" endpoint (described below) is deprecated.
\nWe recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\nNote that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
", + "descriptionHTML": "The \"Remove team member\" endpoint (described below) is deprecated.
\nWe recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -490784,7 +497403,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe 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 Create a team.
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 endpoint.
\nTeam members will include the members of child teams.
\nTo get a user's membership with a team, the team must be visible to the authenticated user.
\nNote:\nThe 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 Create a team.
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 endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\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.
\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.
", + "descriptionHTML": "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 endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
\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.
\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.
", "statusCodes": [ { "httpStatusCode": "200", @@ -490968,7 +497587,7 @@ } ], "previews": [], - "descriptionHTML": "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 endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
", + "descriptionHTML": "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 endpoint.
\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.
\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.
\nNote: 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 Enterprise Server 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 Enterprise Server.\"
", "statusCodes": [ { "httpStatusCode": "204", @@ -493005,7 +499624,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.
\nNote: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.
Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. 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 Enterprise Server. For more information, see 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\".
", + "descriptionHTML": "Provides publicly available information about someone with a GitHub account.
\nGitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"Identifying and authorizing users for GitHub Apps\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"
The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. 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 Enterprise Server. For more information, see 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\".
", "statusCodes": [ { "httpStatusCode": "200", @@ -494416,7 +501035,7 @@ } ], "previews": [], - "descriptionHTML": "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.
The 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:
curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192Provides 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.
The 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:
curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\nLists your publicly visible email address, which you can set with the 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 endpoint. This endpoint is accessible with the user:email scope.
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.\"
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.\"
The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"
", + "description": "The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"
", "isRequired": true } ], @@ -498492,7 +505111,7 @@ } ], "previews": [], - "descriptionHTML": "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.\"
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.\"
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.\"
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.\"
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.\"
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.\"
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -500039,7 +506658,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for.
", + "description": "Determines what events the hook is triggered for.
", "default": [ "push" ] @@ -500235,7 +506854,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -500543,7 +507162,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -500700,7 +507319,7 @@ "type": "object", "name": "config", "in": "body", - "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", + "description": "Key/value pairs to provide settings for this webhook. These are defined below.
", "childParamsGroups": [ { "type": "string", @@ -500716,7 +507335,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
Determines what events the hook is triggered for. This replaces the entire array of events.
", + "description": "Determines what events the hook is triggered for. This replaces the entire array of events.
", "default": [ "push" ] @@ -500918,7 +507537,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", "examples": [ "\"********\"" ] @@ -501164,7 +507783,7 @@ } ], "previews": [], - "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", + "descriptionHTML": "This will trigger a ping event to be sent to the hook.
", "statusCodes": [ { "httpStatusCode": "204", diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json index 1628d4d005..f01b572c31 100644 --- a/src/rest/data/ghes-3.6/schema.json +++ b/src/rest/data/ghes-3.6/schema.json @@ -216515,13 +216515,13 @@ }, { "name": "tree_sha", + "description": "The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -216829,7 +216829,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -219658,7 +219658,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -229695,7 +229695,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
The SHA1 value or ref (branch or tag) name of the tree.
", "in": "path", "required": true, "schema": { "type": "string" }, - "x-multi-segment": true, - "description": "" + "x-multi-segment": true }, { "name": "recursive", @@ -232384,7 +232384,7 @@ } ], "previews": [], - "descriptionHTML": "Returns a single tree using the SHA1 value for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
Returns a single tree using the SHA1 value or ref name for that tree.
\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.
Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
A branch protection rule was created.
", - "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission
", "bodyParameters": [ { "type": "string", @@ -48,7 +48,7 @@ "type": "object", "name": "rule", "in": "body", - "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
Whether the most recent push must be approved by someone other than the person who pushed it
" + }, { "type": "integer", "name": "required_approving_review_count", @@ -266,7 +271,7 @@ }, "deleted": { "descriptionHtml": "A branch protection rule was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -312,7 +317,7 @@ "type": "object", "name": "rule", "in": "body", - "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
Whether the most recent push must be approved by someone other than the person who pushed it
" + }, { "type": "integer", "name": "required_approving_review_count", @@ -530,7 +540,7 @@ }, "edited": { "descriptionHtml": "A branch protection rule was edited.
", - "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -685,7 +695,7 @@ "type": "object", "name": "rule", "in": "body", - "description": "The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.
Whether the most recent push must be approved by someone other than the person who pushed it
" + }, { "type": "integer", "name": "required_approving_review_count", @@ -905,7 +920,7 @@ "cache_sync": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", + "summaryHtml": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"About repository caching.\"
", "bodyParameters": [ { "type": "string", @@ -983,7 +998,7 @@ "check_run": { "completed": { "descriptionHtml": "A check run was completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
Enable or disable Dependabot security updates for the repository.
", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "The enablement status of Dependabot security updates for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, { "type": "object", "name": "secret_scanning", @@ -3088,7 +3119,7 @@ }, "created": { "descriptionHtml": "A new check run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
Enable or disable Dependabot security updates for the repository.
", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "The enablement status of Dependabot security updates for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, { "type": "object", "name": "secret_scanning", @@ -5192,8 +5239,8 @@ "category": "check_run" }, "requested_action": { - "descriptionHtml": "A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
Enable or disable Dependabot security updates for the repository.
", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "The enablement status of Dependabot security updates for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, { "type": "object", "name": "secret_scanning", @@ -7312,7 +7375,7 @@ }, "rerequested": { "descriptionHtml": "Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.
\nFor activity relating to check suites, use the check-suite event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the created and completed event types in repositories.
Note: The API only looks for pushes in the repository where the check run was 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.
Enable or disable Dependabot security updates for the repository.
", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "The enablement status of Dependabot security updates for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, { "type": "object", "name": "secret_scanning", @@ -9419,7 +9498,7 @@ "check_suite": { "completed": { "descriptionHtml": "All check runs in a check suite have completed, and a conclusion is available.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -10316,8 +10395,8 @@ "category": "check_suite" }, "requested": { - "descriptionHtml": "Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -11212,8 +11291,8 @@ "category": "check_suite" }, "rerequested": { - "descriptionHtml": "Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", - "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.
\nFor activity relating to check runs, use the check_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at lease write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the completed event types in repositories.
Note: The API only looks for pushes in the repository where the check suite was 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.
The check_suite.
", + "description": "The check_suite.
", "isRequired": true, "childParamsGroups": [ { @@ -12110,7 +12189,7 @@ "code_scanning_alert": { "appeared_in_branch": { "descriptionHtml": "A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -12515,7 +12594,7 @@ }, "closed_by_user": { "descriptionHtml": "Someone closed a code scanning alert.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -12949,7 +13028,7 @@ }, "created": { "descriptionHtml": "A code scanning alert was created in a repository.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -13283,7 +13362,7 @@ }, "fixed": { "descriptionHtml": "A code scanning alert was fixed in a branch by a commit.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -13721,7 +13800,7 @@ }, "reopened": { "descriptionHtml": "A previously fixed code scanning alert reappeared in a branch.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -14036,7 +14115,7 @@ }, "reopened_by_user": { "descriptionHtml": "Someone reopened a code scanning alert.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -14322,7 +14401,7 @@ "commit_comment": { "created": { "descriptionHtml": "Someone commented on a commit.
", - "summaryHtml": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.
\nFor activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.
\nFor activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -14339,7 +14418,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The commit comment resource.
", + "description": "The commit comment resource.
", "isRequired": true, "childParamsGroups": [ { @@ -14711,7 +14790,7 @@ "type": "string", "name": "ref", "in": "body", - "description": "The git ref resource.
The git ref resource.
The git ref resource.
The git ref resource.
A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -15413,7 +15492,7 @@ }, "dismissed": { "descriptionHtml": "A Dependabot alert was manually closed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -15995,7 +16074,7 @@ }, "fixed": { "descriptionHtml": "A manifest file change removed a vulnerability.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -16577,7 +16656,7 @@ }, "reintroduced": { "descriptionHtml": "A manifest file change introduced a vulnerable dependency that had previously been fixed.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -17159,7 +17238,7 @@ }, "reopened": { "descriptionHtml": "A Dependabot alert was manually reopened.
", - "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to Dependabot alerts.
\nFor more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.
\nNote: Webhook events for Dependabot alerts are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -17743,7 +17822,7 @@ "deploy_key": { "created": { "descriptionHtml": "A deploy key was created.
", - "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -17774,7 +17853,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
A deploy key was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -17896,7 +17975,7 @@ "type": "object", "name": "key", "in": "body", - "description": "The deploy key resource.
The deploy key resource.
A deployment was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment status, use the deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment status, use the deployment_status event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -18006,7 +18085,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -20079,10 +20158,3749 @@ "category": "deployment" } }, + "deployment_protection_rule": { + "requested": { + "descriptionHtml": "A deployment protection rule was requested for an environment.
", + "summaryHtml": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "enum": [ + "requested" + ], + "childParamsGroups": [] + }, + { + "type": "string", + "name": "environment", + "in": "body", + "description": "The name of the environment that has the deployment protection rule.
" + }, + { + "type": "string", + "name": "event", + "in": "body", + "description": "The event that triggered the deployment protection rule.
" + }, + { + "type": "string", + "name": "deployment_callback_url", + "in": "body", + "description": "The URL to review the deployment protection rule.
" + }, + { + "type": "object", + "name": "deployment", + "in": "body", + "description": "A request for a specific ref(branch,sha,tag) to be deployed
", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the deployment
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or sha.
", + "isRequired": true + }, + { + "type": "string", + "name": "task", + "description": "Parameter to specify a task to execute
", + "isRequired": true + }, + { + "type": "object or string", + "name": "payload", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "original_environment", + "description": "" + }, + { + "type": "string", + "name": "environment", + "description": "Name for the target deployment environment.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repository_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "transient_environment", + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.
" + }, + { + "type": "boolean", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.
" + }, + { + "type": "object", + "name": "performed_via_github_app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the GitHub app
", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "The slug name of the GitHub app
" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "name", + "description": "The name of the GitHub app
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "external_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "The set of permissions for the GitHub app
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "issues", + "description": "" + }, + { + "type": "string", + "name": "checks", + "description": "" + }, + { + "type": "string", + "name": "metadata", + "description": "" + }, + { + "type": "string", + "name": "contents", + "description": "" + }, + { + "type": "string", + "name": "deployments", + "description": "" + } + ] + }, + { + "type": "array of strings", + "name": "events", + "description": "The list of events for the GitHub app
", + "isRequired": true + }, + { + "type": "integer", + "name": "installations_count", + "description": "The number of installations associated with the GitHub app
" + }, + { + "type": "string", + "name": "client_id", + "description": "" + }, + { + "type": "string", + "name": "client_secret", + "description": "" + }, + { + "type": "string or null", + "name": "webhook_secret", + "description": "" + }, + { + "type": "string", + "name": "pem", + "description": "" + } + ] + } + ] + }, + { + "type": "array of objects", + "name": "pull_requests", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "diff_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "patch_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "review_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "Number uniquely identifying the pull request within its repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "State of this Pull Request. Either open or closed.
The title of the pull request.
", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "body", + "description": "", + "isRequired": true + }, + { + "type": "array of objects", + "name": "labels", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "color", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "default", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "milestone", + "description": "A collection of related issues and pull requests.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "The number of the milestone.
", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "The state of the milestone.
", + "isRequired": true, + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + { + "type": "string", + "name": "title", + "description": "The title of the milestone.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "creator", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "closed_issues", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "due_on", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string or null", + "name": "active_lock_reason", + "description": "" + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "closed_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merged_at", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "merge_commit_sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "assignee", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_reviewers", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "array of objects or null", + "name": "requested_teams", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "URL for the team
", + "isRequired": true + }, + { + "type": "string", + "name": "members_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "Name of the team
", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "Description of the team
", + "isRequired": true + }, + { + "type": "string", + "name": "permission", + "description": "Permission that the team will have for its repositories
", + "isRequired": true + }, + { + "type": "string", + "name": "privacy", + "description": "The level of privacy this team should have
" + }, + { + "type": "string", + "name": "notification_setting", + "description": "The notification setting the team has set
" + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repositories_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "slug", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ldap_dn", + "description": "Distinguished Name (DN) that team maps to within LDAP environment
" + } + ] + }, + { + "type": "object", + "name": "head", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object or null", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "The repository visibility: public, private, or internal.
" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object or null", + "name": "license", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "base", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "label", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ref", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "repo", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "archive_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "assignees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "blobs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "branches_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "collaborators_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "comments_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "compare_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contents_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "contributors_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "deployments_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "description", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "downloads_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "fork", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "forks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "full_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_commits_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_refs_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "hooks_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "is_template", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_comment_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issue_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "issues_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "keys_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "labels_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "languages_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "merges_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "milestones_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "notifications_url", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "owner", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "private", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "pulls_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "releases_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "stargazers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "statuses_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscribers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscription_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "tags_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "teams_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "trees_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "clone_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "default_branch", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "forks_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "git_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_downloads", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_issues", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_projects", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_wiki", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_pages", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "has_discussions", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "homepage", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "language", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "master_branch", + "description": "" + }, + { + "type": "boolean", + "name": "archived", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "disabled", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "description": "The repository visibility: public, private, or internal.
" + }, + { + "type": "string or null", + "name": "mirror_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "open_issues_count", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "permissions", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "admin", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintain", + "description": "" + }, + { + "type": "boolean", + "name": "push", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "triage", + "description": "" + }, + { + "type": "boolean", + "name": "pull", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "temp_clone_token", + "description": "" + }, + { + "type": "boolean", + "name": "allow_merge_commit", + "description": "" + }, + { + "type": "boolean", + "name": "allow_squash_merge", + "description": "" + }, + { + "type": "boolean", + "name": "allow_rebase_merge", + "description": "" + }, + { + "type": "object", + "name": "license", + "description": "License Simple
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "key", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "spdx_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "pushed_at", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "size", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "ssh_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "stargazers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "svn_url", + "description": "", + "isRequired": true + }, + { + "type": "array of strings", + "name": "topics", + "description": "" + }, + { + "type": "integer", + "name": "watchers", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "watchers_count", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "updated_at", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "allow_forking", + "description": "" + }, + { + "type": "boolean", + "name": "web_commit_signoff_required", + "description": "" + } + ] + }, + { + "type": "string", + "name": "sha", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "user", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "object", + "name": "_links", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "comments", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "commits", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "statuses", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "html", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "issue", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comments", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "review_comment", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "self", + "description": "Hypermedia Link
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "href", + "description": "", + "isRequired": true + } + ] + } + ] + }, + { + "type": "string", + "name": "author_association", + "description": "How the author is associated with the repository.
", + "isRequired": true, + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + { + "type": "object or null", + "name": "auto_merge", + "description": "The status of auto merging a pull request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "enabled_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string", + "name": "merge_method", + "description": "The merge method to use.
", + "isRequired": true, + "enum": [ + "merge", + "squash", + "rebase" + ] + }, + { + "type": "string", + "name": "commit_title", + "description": "Title for the merge commit message.
", + "isRequired": true + }, + { + "type": "string", + "name": "commit_message", + "description": "Commit message for the merge commit.
", + "isRequired": true + } + ] + }, + { + "type": "boolean", + "name": "draft", + "description": "Indicates whether or not the pull request is a draft.
" + }, + { + "type": "boolean", + "name": "merged", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "mergeable", + "description": "", + "isRequired": true + }, + { + "type": "boolean or null", + "name": "rebaseable", + "description": "" + }, + { + "type": "string", + "name": "mergeable_state", + "description": "", + "isRequired": true + }, + { + "type": "object", + "name": "merged_by", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "integer", + "name": "comments", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "review_comments", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "maintainer_can_modify", + "description": "Indicates whether maintainers can modify the pull request.
", + "isRequired": true + }, + { + "type": "integer", + "name": "commits", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "additions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "deletions", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "changed_files", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "requested", + "category": "deployment_protection_rule" + } + }, "deployment_status": { "created": { "descriptionHtml": "A new deployment status was created.
", - "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.
\nFor activity relating to deployment creation, use the deployment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -20197,7 +24015,7 @@ "type": "object", "name": "deployment", "in": "body", - "description": "The deployment.
", + "description": "The deployment.
", "isRequired": true, "childParamsGroups": [ { @@ -20927,7 +24745,7 @@ "type": "object", "name": "deployment_status", "in": "body", - "description": "The deployment status.
", + "description": "The deployment status.
", "isRequired": true, "childParamsGroups": [ { @@ -22985,7 +26803,7 @@ "discussion": { "answered": { "descriptionHtml": "A comment on the discussion was marked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -23832,7 +27650,7 @@ }, "category_changed": { "descriptionHtml": "The category of a discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -24491,7 +28309,7 @@ }, "closed": { "descriptionHtml": "A discussion was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -25066,7 +28884,7 @@ }, "created": { "descriptionHtml": "A discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -25134,7 +28952,7 @@ }, "deleted": { "descriptionHtml": "A discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -25709,7 +29527,7 @@ }, "edited": { "descriptionHtml": "The title or body on a discussion was edited, or the category of the discussion was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -26318,7 +30136,7 @@ }, "labeled": { "descriptionHtml": "A label was added to a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -26944,7 +30762,7 @@ }, "locked": { "descriptionHtml": "A discussion was locked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -27519,7 +31337,7 @@ }, "pinned": { "descriptionHtml": "A discussion was pinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -28094,7 +31912,7 @@ }, "reopened": { "descriptionHtml": "A discussion was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -28669,7 +32487,7 @@ }, "transferred": { "descriptionHtml": "A discussion was transferred to another repository.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -31268,7 +35086,7 @@ }, "unanswered": { "descriptionHtml": "A comment on the discussion was unmarked as the answer.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -32100,7 +35918,7 @@ }, "unlabeled": { "descriptionHtml": "A label was removed from a discussion.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -32726,7 +36544,7 @@ }, "unlocked": { "descriptionHtml": "A discussion was unlocked.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -33301,7 +37119,7 @@ }, "unpinned": { "descriptionHtml": "A discussion was unpinned.
", - "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a comment on a discussion, use the discussion_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -33878,7 +37696,7 @@ "discussion_comment": { "created": { "descriptionHtml": "A comment on a discussion was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -34726,7 +38544,7 @@ }, "deleted": { "descriptionHtml": "A comment on a discussion was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -35574,7 +39392,7 @@ }, "edited": { "descriptionHtml": "A comment on a discussion was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.
\nFor activity relating to a discussion as opposed to comments on a discussion, use the discussion event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.
\nNote: Webhook events for GitHub Discussions are currently in beta and subject to change.
", "bodyParameters": [ { "type": "string", @@ -36447,7 +40265,7 @@ "enterprise": { "anonymous_access_disabled": { "descriptionHtml": "Anonymous Git read access was disabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", @@ -36476,7 +40294,7 @@ }, "anonymous_access_enabled": { "descriptionHtml": "Anonymous Git read access was enabled.
", - "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", + "summaryHtml": "This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see \"Enforcing repository management policies in your enterprise.\"
", "bodyParameters": [ { "type": "string", @@ -36507,7 +40325,7 @@ "fork": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", @@ -36520,7 +40338,7 @@ "type": "", "name": "forkee", "in": "body", - "description": "The created repository resource.
The created repository resource.
Someone revoked their authorization of a GitHub App.
", - "summaryHtml": "This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.
\nAnyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"
This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.
\nAnyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"
This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", @@ -36728,7 +40546,7 @@ "installation": { "created": { "descriptionHtml": "Someone installed a GitHub App on a user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -36945,7 +40763,7 @@ }, "deleted": { "descriptionHtml": "Someone uninstalled a GitHub App from their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37048,7 +40866,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "Someone granted new permissions to a GitHub App.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37151,7 +40969,7 @@ }, "suspend": { "descriptionHtml": "Someone blocked access by a GitHub App to their user or organization account.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37254,7 +41072,7 @@ }, "unsuspend": { "descriptionHtml": "A GitHub App that was blocked from accessing a user or organization account was given access the account again.
", - "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37359,7 +41177,7 @@ "installation_repositories": { "added": { "descriptionHtml": "A GitHub App installation was granted access to one or more repositories.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37623,7 +41441,7 @@ }, "removed": { "descriptionHtml": "Access to one or more repositories was revoked for a GitHub App installation.
", - "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
\nFor more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "string", @@ -37894,7 +41712,7 @@ "installation_target": { "default": { "descriptionHtml": "Somebody renamed the user or organization account that a GitHub App is installed on.
", - "summaryHtml": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", + "summaryHtml": "This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.
", "bodyParameters": [ { "type": "object", @@ -38181,7 +41999,7 @@ "issue_comment": { "created": { "descriptionHtml": "A comment on an issue or pull request was created.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -38198,7 +42016,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -38729,7 +42547,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -38766,7 +42584,7 @@ }, "deleted": { "descriptionHtml": "A comment on an issue or pull request was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -38783,7 +42601,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -39315,7 +43133,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -39352,7 +43170,7 @@ }, "edited": { "descriptionHtml": "A comment on an issue or pull request was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.
\nFor activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -39391,7 +43209,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -39923,7 +43741,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue the comment belongs to.
", + "description": "The issue the comment belongs to.
", "isRequired": true }, { @@ -39962,7 +43780,7 @@ "issues": { "assigned": { "descriptionHtml": "An issue was assigned to a user.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -40113,7 +43931,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -41427,7 +45245,7 @@ }, "closed": { "descriptionHtml": "An issue was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -41458,7 +45276,7 @@ "type": "", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true }, { @@ -41495,7 +45313,7 @@ }, "deleted": { "descriptionHtml": "An issue was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -41526,7 +45344,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -42836,7 +46654,7 @@ }, "demilestoned": { "descriptionHtml": "An issue was removed from a milestone.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -43127,7 +46945,7 @@ }, "edited": { "descriptionHtml": "The title or body on an issue was edited.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -43193,7 +47011,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -44557,7 +48375,7 @@ }, "labeled": { "descriptionHtml": "A label was added to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -44588,7 +48406,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -45951,8 +49769,8 @@ "category": "issues" }, "locked": { - "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -46020,7 +49838,7 @@ }, "milestoned": { "descriptionHtml": "An issue was added to a milestone.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -46312,7 +50130,7 @@ }, "opened": { "descriptionHtml": "An issue was created. When a closed issue is reopened, the action will be reopened instead.
This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -46334,7 +50152,7 @@ { "type": "object or null", "name": "old_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -48348,7 +52166,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -49659,8 +53477,8 @@ "category": "issues" }, "pinned": { - "descriptionHtml": "An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "descriptionHtml": "An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -49691,7 +53509,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -51001,7 +54819,7 @@ }, "reopened": { "descriptionHtml": "A closed issue was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -51068,8 +54886,8 @@ "category": "issues" }, "transferred": { - "descriptionHtml": "An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "descriptionHtml": "An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -51092,7 +54910,7 @@ { "type": "object", "name": "new_issue", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -53118,7 +56936,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -54428,7 +58246,7 @@ }, "unassigned": { "descriptionHtml": "A user was unassigned from an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -54580,7 +58398,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -55894,7 +59712,7 @@ }, "unlabeled": { "descriptionHtml": "A label was removed from an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -55925,7 +59743,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -57288,8 +61106,8 @@ "category": "issues" }, "unlocked": { - "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "descriptionHtml": "Conversation on an issue was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -57356,8 +61174,8 @@ "category": "issues" }, "unpinned": { - "descriptionHtml": "An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", + "descriptionHtml": "An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.
\nFor activity relating to a comment on an issue, use the issue_comment event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -57388,7 +61206,7 @@ "type": "object", "name": "issue", "in": "body", - "description": "The issue itself.
", + "description": "The issue itself.
", "isRequired": true, "childParamsGroups": [ { @@ -58700,7 +62518,7 @@ "label": { "created": { "descriptionHtml": "A label was created.
", - "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -58811,7 +62629,7 @@ }, "deleted": { "descriptionHtml": "A label was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -58923,7 +62741,7 @@ }, "edited": { "descriptionHtml": "A label's name, description, or color was changed.
", - "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.
\nIf you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -59084,7 +62902,7 @@ "member": { "added": { "descriptionHtml": "A GitHub user accepted an invitation to a repository.
", - "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -59293,7 +63111,7 @@ }, "edited": { "descriptionHtml": "Permissions were changed for a collaborator on a repository.
", - "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -59515,7 +63333,7 @@ }, "removed": { "descriptionHtml": "A collaborator was removed from a repository.
", - "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -59700,7 +63518,7 @@ "membership": { "added": { "descriptionHtml": "An organization member was added to a team.
", - "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -59983,6 +63801,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -60018,6 +63846,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -60046,7 +63883,7 @@ }, "removed": { "descriptionHtml": "An organization member was removed from a team.
", - "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the API to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the API to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -60330,6 +64167,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -60365,6 +64212,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -60551,7 +64407,7 @@ "milestone": { "closed": { "descriptionHtml": "A milestone was closed.
", - "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", @@ -60836,7 +64692,7 @@ }, "created": { "descriptionHtml": "A milestone was created.
", - "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", @@ -61120,7 +64976,7 @@ }, "deleted": { "descriptionHtml": "A milestone was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", @@ -61405,7 +65261,7 @@ }, "edited": { "descriptionHtml": "A milestone was edited.
", - "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", @@ -61738,7 +65594,7 @@ }, "opened": { "descriptionHtml": "A milestone was opened.
", - "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", + "summaryHtml": "This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.
\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.
", "bodyParameters": [ { "type": "string", @@ -62024,7 +65880,7 @@ "organization": { "deleted": { "descriptionHtml": "An organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -62237,7 +66093,7 @@ }, "member_added": { "descriptionHtml": "A member accepted an invitation to join an organization.
", - "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -62451,7 +66307,7 @@ }, "member_invited": { "descriptionHtml": "A member was invited to join the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -62826,7 +66682,7 @@ }, "member_removed": { "descriptionHtml": "A member was removed from the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -63040,7 +66896,7 @@ }, "renamed": { "descriptionHtml": "The name of an organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.
\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -63275,7 +67131,7 @@ "package": { "published": { "descriptionHtml": "A package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -64376,7 +68232,7 @@ }, "updated": { "descriptionHtml": "A previously published package was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -65239,13 +69095,13 @@ "page_build": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.
", + "summaryHtml": "This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.
", "bodyParameters": [ { "type": "object", "name": "build", "in": "body", - "description": "The List GitHub Pages builds itself.
", + "description": "The List GitHub Pages builds itself.
", "isRequired": true, "childParamsGroups": [ { @@ -65474,6 +69330,1368 @@ "category": "page_build" } }, + "personal_access_token_request": { + "approved": { + "descriptionHtml": "A fine-grained personal access token request was approved.
", + "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
\nNote: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "approved" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "personal_access_token_request", + "in": "body", + "description": "Details of a Personal Access Token Request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_added", + "description": "New requested permissions, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_upgraded", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_result", + "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", + "isRequired": true, + "enum": [ + "none", + "all", + "subset" + ] + }, + { + "type": "integer or null", + "name": "repository_count", + "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "Date and time when the request for access was created.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "token_expired", + "description": "Whether the associated fine-grained personal access token has expired.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_expires_at", + "description": "Date and time when the associated fine-grained personal access token expires.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_last_used_at", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "approved", + "category": "personal_access_token_request" + }, + "cancelled": { + "descriptionHtml": "A fine-grained personal access token request was cancelled by the requester.
", + "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
\nNote: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "cancelled" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "personal_access_token_request", + "in": "body", + "description": "Details of a Personal Access Token Request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_added", + "description": "New requested permissions, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_upgraded", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_result", + "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", + "isRequired": true, + "enum": [ + "none", + "all", + "subset" + ] + }, + { + "type": "integer or null", + "name": "repository_count", + "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "Date and time when the request for access was created.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "token_expired", + "description": "Whether the associated fine-grained personal access token has expired.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_expires_at", + "description": "Date and time when the associated fine-grained personal access token expires.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_last_used_at", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "cancelled", + "category": "personal_access_token_request" + }, + "created": { + "descriptionHtml": "A fine-grained personal access token request was created.
", + "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
\nNote: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "personal_access_token_request", + "in": "body", + "description": "Details of a Personal Access Token Request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_added", + "description": "New requested permissions, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_upgraded", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_result", + "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", + "isRequired": true, + "enum": [ + "none", + "all", + "subset" + ] + }, + { + "type": "integer or null", + "name": "repository_count", + "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "Date and time when the request for access was created.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "token_expired", + "description": "Whether the associated fine-grained personal access token has expired.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_expires_at", + "description": "Date and time when the associated fine-grained personal access token expires.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_last_used_at", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "created", + "category": "personal_access_token_request" + }, + "denied": { + "descriptionHtml": "A fine-grained personal access token request was denied.
", + "summaryHtml": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.
\nNote: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "denied" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "personal_access_token_request", + "in": "body", + "description": "Details of a Personal Access Token Request.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "id", + "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the pat_request_id parameter in the list and review API calls.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_added", + "description": "New requested permissions, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_upgraded", + "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "object", + "name": "organization", + "description": "" + }, + { + "type": "object", + "name": "repository", + "description": "" + }, + { + "type": "object", + "name": "other", + "description": "" + } + ] + }, + { + "type": "object", + "name": "permissions_result", + "description": "Permissions requested, categorized by type of permission. This field incorporates permissions_added and permissions_upgraded.
Type of repository selection requested.
", + "isRequired": true, + "enum": [ + "none", + "all", + "subset" + ] + }, + { + "type": "integer or null", + "name": "repository_count", + "description": "The number of repositories the token is requesting access to. This field is only populated when repository_selection is subset.
An array of repository objects the token is requesting access to. This field is only populated when repository_selection is subset.
Unique identifier of the repository
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "The name of the repository.
", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "private", + "description": "Whether the repository is private or public.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "Date and time when the request for access was created.
", + "isRequired": true + }, + { + "type": "boolean", + "name": "token_expired", + "description": "Whether the associated fine-grained personal access token has expired.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_expires_at", + "description": "Date and time when the associated fine-grained personal access token expires.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "token_last_used_at", + "description": "Date and time when the associated fine-grained personal access token was last used for authentication.
", + "isRequired": true + } + ] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "app" + ], + "action": "denied", + "category": "personal_access_token_request" + } + }, "ping": { "default": { "descriptionHtml": "", @@ -65515,7 +70733,7 @@ { "type": "string", "name": "secret", - "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.
A note in a classic project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -65940,7 +71158,7 @@ }, "created": { "descriptionHtml": "A card was added to a classic project.
", - "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -66199,7 +71417,7 @@ }, "deleted": { "descriptionHtml": "A card on a classic project was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -66459,7 +71677,7 @@ }, "edited": { "descriptionHtml": "A note on a classic project was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -66741,7 +71959,7 @@ }, "moved": { "descriptionHtml": "A card on a classic project was moved to another column or to another position in its column.
", - "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a card on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a column on a project, use the project and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -66832,7 +72050,7 @@ "project": { "closed": { "descriptionHtml": "A classic project was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -67097,7 +72315,7 @@ }, "created": { "descriptionHtml": "A classic project was created.
", - "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -67362,7 +72580,7 @@ }, "deleted": { "descriptionHtml": "A classic project was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -67626,7 +72844,7 @@ }, "edited": { "descriptionHtml": "The name or description of a classic project was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -67924,7 +73142,7 @@ }, "reopened": { "descriptionHtml": "A classic project was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a card or column on a project, use the project_card and project_column event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -68191,7 +73409,7 @@ "project_column": { "created": { "descriptionHtml": "A column was added to a classic project.
", - "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -68312,7 +73530,7 @@ }, "deleted": { "descriptionHtml": "A column was deleted from a classic project.
", - "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -68433,7 +73651,7 @@ }, "edited": { "descriptionHtml": "The name of a column on a classic project was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -68576,7 +73794,7 @@ }, "moved": { "descriptionHtml": "A column was moved to a new position on a classic project.
", - "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to a column on a classic project. For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.
\nFor activity relating to a project or a card on a project, use the project and project_card event. For activity relating to Projects instead of Projects (classic), use the projects_v2 event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.
", "bodyParameters": [ { "type": "string", @@ -68700,7 +73918,7 @@ "projects_v2": { "closed": { "descriptionHtml": "A project in the organization was closed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -69213,7 +74431,7 @@ }, "created": { "descriptionHtml": "A project in the organization was created.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -69726,7 +74944,7 @@ }, "deleted": { "descriptionHtml": "A project in the organization was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -70239,7 +75457,7 @@ }, "edited": { "descriptionHtml": "The title, description, or README of a project in the organization was changed.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -70829,7 +76047,7 @@ }, "reopened": { "descriptionHtml": "A project in the organization was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -71343,8 +76561,8 @@ }, "projects_v2_item": { "archived": { - "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "descriptionHtml": "An item on an organization project was archived. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -71605,7 +76823,7 @@ }, "converted": { "descriptionHtml": "A draft issue in an organization project was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -71866,7 +77084,7 @@ }, "created": { "descriptionHtml": "An item was added to a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -72101,7 +77319,7 @@ }, "deleted": { "descriptionHtml": "An item was deleted from a project in the organization.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -72336,7 +77554,7 @@ }, "edited": { "descriptionHtml": "The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -72577,7 +77795,7 @@ }, "reordered": { "descriptionHtml": "The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -72837,8 +78055,8 @@ "category": "projects_v2_item" }, "restored": { - "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", - "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", + "descriptionHtml": "An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"
", + "summaryHtml": "This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.
\nFor activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.
\nNote: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.
", "bodyParameters": [ { "type": "string", @@ -73101,7 +78319,7 @@ "public": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "object", @@ -73153,7 +78371,7 @@ "pull_request": { "assigned": { "descriptionHtml": "A pull request was assigned to a user.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -76486,8 +81704,8 @@ "category": "pull_request" }, "auto_merge_disabled": { - "descriptionHtml": "Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -79704,8 +84922,8 @@ "category": "pull_request" }, "auto_merge_enabled": { - "descriptionHtml": "Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -82923,7 +88141,7 @@ }, "closed": { "descriptionHtml": "A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.
This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -82997,8 +88215,8 @@ "category": "pull_request" }, "converted_to_draft": { - "descriptionHtml": "A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -83073,7 +88291,7 @@ }, "demilestoned": { "descriptionHtml": "A pull request was removed from a milestone.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -86513,7 +91731,7 @@ }, "edited": { "descriptionHtml": "The title or body of a pull request was edited.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -86657,7 +91875,7 @@ }, "labeled": { "descriptionHtml": "A label was added to a pull request.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -89920,8 +95138,8 @@ "category": "pull_request" }, "locked": { - "descriptionHtml": "Conversation on a pull request was locked. For more information, see \"Locking conversations.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "Conversation on a pull request was locked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -93133,7 +98351,7 @@ }, "milestoned": { "descriptionHtml": "A pull request was added to a milestone.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -96573,7 +101791,7 @@ }, "opened": { "descriptionHtml": "A pull request was created
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -96647,8 +101865,8 @@ "category": "pull_request" }, "ready_for_review": { - "descriptionHtml": "A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -96723,7 +101941,7 @@ }, "reopened": { "descriptionHtml": "A previously closed pull request was reopened.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -96798,7 +102016,7 @@ }, "review_request_removed": { "descriptionHtml": "A request for review by a person or team was removed from a pull request.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -100300,8 +105518,8 @@ "category": "pull_request" }, "review_requested": { - "descriptionHtml": "Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -103790,7 +109008,7 @@ }, "synchronize": { "descriptionHtml": "A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -107017,7 +112235,7 @@ }, "unassigned": { "descriptionHtml": "A user was unassigned from a pull request.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -110351,7 +115569,7 @@ }, "unlabeled": { "descriptionHtml": "A label was removed from a pull request.
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -113613,8 +118831,8 @@ "category": "pull_request" }, "unlocked": { - "descriptionHtml": "Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"
", - "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "descriptionHtml": "Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"
", + "summaryHtml": "This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -116826,7 +122044,7 @@ "pull_request_review_comment": { "created": { "descriptionHtml": "A comment on a pull request diff was created.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -116843,7 +122061,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -120268,7 +125486,7 @@ }, "deleted": { "descriptionHtml": "A comment on a pull request diff was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -120285,7 +125503,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -123709,7 +128927,7 @@ }, "edited": { "descriptionHtml": "The content of a comment on a pull request diff was changed.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -123748,7 +128966,7 @@ "type": "object", "name": "comment", "in": "body", - "description": "The comment itself.
", + "description": "The comment itself.
", "isRequired": true, "childParamsGroups": [ { @@ -127175,7 +132393,7 @@ "pull_request_review": { "dismissed": { "descriptionHtml": "A review on a pull request was dismissed.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -130441,7 +135659,7 @@ }, "edited": { "descriptionHtml": "The body comment on a pull request review was edited.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -133612,7 +138830,7 @@ }, "submitted": { "descriptionHtml": "A review on a pull request was submitted.
", - "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -136875,7 +142093,7 @@ "pull_request_review_thread": { "resolved": { "descriptionHtml": "A comment thread on a pull request was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request review comment threads, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request review comment threads, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -140244,7 +145462,7 @@ }, "unresolved": { "descriptionHtml": "A previously resolved comment thread on a pull request was marked as unresolved.
", - "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.
\nFor activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -143640,7 +148858,7 @@ "type": "array of objects", "name": "commits", "in": "body", - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 20 commits. If necessary, you can use the Commits API to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.
A package was published to a registry.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead.
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead.
A package that was previously published to a registry was updated.
", - "summaryHtml": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead
This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.
\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.
\nNote: GitHub recommends that you use the newer package event instead
A draft was saved, or a release or pre-release was published without previously being saved as a draft.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -145872,7 +151090,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -146394,7 +151612,7 @@ }, "deleted": { "descriptionHtml": "A release, pre-release, or draft release was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -146432,7 +151650,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -146953,8 +152171,8 @@ "category": "release" }, "edited": { - "descriptionHtml": "The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "descriptionHtml": "The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -147040,7 +152258,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -147561,7 +152779,7 @@ }, "prereleased": { "descriptionHtml": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -147628,7 +152846,7 @@ }, "published": { "descriptionHtml": "A release, pre-release, or draft of a release was published.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -147695,7 +152913,7 @@ }, "released": { "descriptionHtml": "A release was published, or a pre-release was changed to a release.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -147733,7 +152951,7 @@ "type": "object", "name": "release", "in": "body", - "description": "The release object.
", + "description": "The release object.
", "isRequired": true, "childParamsGroups": [ { @@ -148254,7 +153472,7 @@ }, "unpublished": { "descriptionHtml": "A release or pre-release was unpublished.
", - "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148323,7 +153541,7 @@ "repository": { "anonymous_access_disabled": { "descriptionHtml": "Someone disabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148383,7 +153601,7 @@ }, "anonymous_access_enabled": { "descriptionHtml": "Someone enabled anonymous Git read access to the repository. For more information, see \"Enabling anonymous Git read access for a repository.\"
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148443,7 +153661,7 @@ }, "archived": { "descriptionHtml": "A repository was archived.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148505,7 +153723,7 @@ }, "created": { "descriptionHtml": "A repository was created.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148567,7 +153785,7 @@ }, "deleted": { "descriptionHtml": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148629,7 +153847,7 @@ }, "edited": { "descriptionHtml": "The topics, default branch, description, or homepage of a repository was changed.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148751,7 +153969,7 @@ }, "privatized": { "descriptionHtml": "The visibility of a repository was changed to private.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148813,7 +154031,7 @@ }, "publicized": { "descriptionHtml": "The visibility of a repository was changed to public.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148875,7 +154093,7 @@ }, "renamed": { "descriptionHtml": "The name of a repository was changed.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -148968,7 +154186,7 @@ }, "transferred": { "descriptionHtml": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.
This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -149258,7 +154476,7 @@ }, "unarchived": { "descriptionHtml": "A previously archived repository was unarchived.
", - "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -149322,7 +154540,7 @@ "repository_dispatch": { "default": { "descriptionHtml": "The event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.
This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -149665,7 +154883,7 @@ "secret_scanning_alert": { "created": { "descriptionHtml": "A secret scanning alert was created.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -149715,24 +154933,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -149881,16 +155092,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -150080,7 +155281,7 @@ }, "reopened": { "descriptionHtml": "A previously closed secret scanning alert was reopened.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -150130,24 +155331,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -150296,16 +155490,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -150495,7 +155679,7 @@ }, "resolved": { "descriptionHtml": "A secret scanning alert was closed.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -150508,423 +155692,6 @@ ], "childParamsGroups": [] }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
" - }, - { - "type": "string", - "name": "locations_url", - "description": "The REST API URL of the code locations for this alert.
" - }, - { - "type": "integer", - "name": "number", - "description": "The security alert number.
" - }, - { - "type": "boolean or null", - "name": "push_protection_bypassed", - "description": "Whether push protection was bypassed for the detected secret.
" - }, - { - "type": "string or null", - "name": "push_protection_bypassed_at", - "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution", - "description": "Required when the state is resolved. The reason for resolving the alert.
The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - } - ] - }, - { - "type": "string or null", - "name": "resolution_comment", - "description": "An optional comment to resolve an alert.
" - }, - { - "type": "string", - "name": "secret", - "description": "The secret that was detected.
" - }, - { - "type": "string", - "name": "secret_type", - "description": "The type of secret that secret scanning detected.
" - }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "installation", - "in": "body", - "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "organization", - "in": "body", - "description": "A GitHub organization.
", - "childParamsGroups": [] - }, - { - "type": "object", - "name": "repository", - "in": "body", - "description": "A repository on GitHub.
", - "isRequired": true, - "childParamsGroups": [] - }, - { - "type": "object", - "name": "sender", - "in": "body", - "description": "A GitHub user.
", - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "resolved", - "category": "secret_scanning_alert" - }, - "revoked": { - "descriptionHtml": "A secret scanning alert was marked as revoked.
", - "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "revoked" - ], - "childParamsGroups": [] - }, { "type": "object", "name": "alert", @@ -150962,24 +155729,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151129,14 +155889,402 @@ "description": "The type of secret that secret scanning detected.
" }, { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
An enterprise on GitHub.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "installation", + "in": "body", + "description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "organization", + "in": "body", + "description": "A GitHub organization.
", + "childParamsGroups": [] + }, + { + "type": "object", + "name": "repository", + "in": "body", + "description": "A repository on GitHub.
", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "object", + "name": "sender", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "resolved", + "category": "secret_scanning_alert" + }, + "revoked": { + "descriptionHtml": "A secret scanning alert was marked as revoked.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "revoked" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" }, { "type": "string", - "name": "secret", - "description": "The secret that was detected.
" + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" }, { "type": "boolean or null", @@ -151329,7 +156477,7 @@ "secret_scanning_alert_location": { "created": { "descriptionHtml": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
", - "summaryHtml": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
\nFor more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alerts, use the secret_scanning_alert event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
\nFor more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alerts, use the secret_scanning_alert event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -151378,24 +156526,17 @@ "name": "locations_url", "description": "The REST API URL of the code locations for this alert.
" }, - { - "type": "string", - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Required when the state is resolved. The reason for resolving the alert.
The reason for resolving the alert.
", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", + "pattern_deleted", + "pattern_edited", null ] }, @@ -151544,16 +156685,6 @@ "name": "secret_type", "description": "The type of secret that secret scanning detected.
" }, - { - "type": "string", - "name": "secret_type_display_name", - "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Secret scanning patterns.\"
The secret that was detected.
" - }, { "type": "boolean or null", "name": "push_protection_bypassed", @@ -151766,7 +156897,7 @@ "security_advisory": { "published": { "descriptionHtml": "A security advisory was published to the GitHub community.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -152002,7 +157133,7 @@ }, "updated": { "descriptionHtml": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -152238,7 +157369,7 @@ }, "withdrawn": { "descriptionHtml": "A previously published security advisory was withdrawn.
", - "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", + "summaryHtml": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"About GitHub Security Advisories for repositories.\" For information about the API to manage security advisories, see the GraphQL documentation.
\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"
", "bodyParameters": [ { "type": "string", @@ -152476,7 +157607,7 @@ "security_and_analysis": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", + "summaryHtml": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.
", "bodyParameters": [ { "type": "object", @@ -152511,6 +157642,22 @@ } ] }, + { + "type": "object", + "name": "dependabot_security_updates", + "description": "Enable or disable Dependabot security updates for the repository.
", + "childParamsGroups": [ + { + "type": "string", + "name": "status", + "description": "The enablement status of Dependabot security updates for the repository.
", + "enum": [ + "enabled", + "disabled" + ] + } + ] + }, { "type": "object", "name": "secret_scanning", @@ -152598,7 +157745,7 @@ "sponsorship": { "cancelled": { "descriptionHtml": "A sponsorship was cancelled and the last billing cycle has ended.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -153080,7 +158227,7 @@ }, "created": { "descriptionHtml": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -153562,7 +158709,7 @@ }, "edited": { "descriptionHtml": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -154066,7 +159213,7 @@ }, "pending_cancellation": { "descriptionHtml": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.
\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -154554,7 +159701,7 @@ }, "pending_tier_change": { "descriptionHtml": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -155119,7 +160266,7 @@ }, "tier_changed": { "descriptionHtml": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.
", - "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", + "summaryHtml": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.
\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"
", "bodyParameters": [ { "type": "string", @@ -155680,7 +160827,7 @@ "star": { "created": { "descriptionHtml": "Someone starred a repository.
", - "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -155748,7 +160895,7 @@ }, "deleted": { "descriptionHtml": "Someone unstarred the repository.
", - "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -155818,7 +160965,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", + "summaryHtml": "This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Statuses\" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.
", "bodyParameters": [ { "type": "string or null", @@ -156394,7 +161541,7 @@ "team_add": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"
\nFor activity relating to teams, see the teams event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"
\nFor activity relating to teams, see the teams event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "object", @@ -156535,6 +161682,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -156570,6 +161727,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -156600,7 +161766,7 @@ "team": { "added_to_repository": { "descriptionHtml": "A team was granted access to a repository.
", - "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -156751,6 +161917,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -156786,6 +161962,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -156814,7 +161999,7 @@ }, "created": { "descriptionHtml": "A team was created.
", - "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -156966,6 +162151,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157001,6 +162196,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157029,7 +162233,7 @@ }, "deleted": { "descriptionHtml": "A team was deleted.
", - "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -157180,6 +162384,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157215,6 +162429,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157243,7 +162466,7 @@ }, "edited": { "descriptionHtml": "The name, description, or visibility of a team was changed.
", - "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -157302,6 +162525,19 @@ } ] }, + { + "type": "object", + "name": "notification_setting", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "from", + "description": "The previous version of the team's notification setting if the action was edited.
Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157516,6 +162762,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157544,7 +162799,7 @@ }, "removed_from_repository": { "descriptionHtml": "A team's access to a repository was removed.
", - "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", + "summaryHtml": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.
", "bodyParameters": [ { "type": "string", @@ -157696,6 +162951,16 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "isRequired": true, + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -157731,6 +162996,15 @@ "secret" ] }, + { + "type": "string", + "name": "notification_setting", + "description": "Whether team members will receive notifications when their team is @mentioned
", + "enum": [ + "notifications_enabled", + "notifications_disabled" + ] + }, { "type": "string", "name": "repositories_url", @@ -158117,7 +163391,7 @@ "watch": { "started": { "descriptionHtml": "Someone started watching the repository.
", - "summaryHtml": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -158180,7 +163454,7 @@ "workflow_dispatch": { "default": { "descriptionHtml": "", - "summaryHtml": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"
\nFor activity relating to workflow runs, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", + "summaryHtml": "This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"
\nFor activity relating to workflow runs, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.
", "bodyParameters": [ { "type": "object", @@ -158251,7 +163525,7 @@ "workflow_job": { "completed": { "descriptionHtml": "A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
", - "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -158807,7 +164081,7 @@ }, "in_progress": { "descriptionHtml": "A job in a workflow run started processing on a runner.
", - "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -159363,7 +164637,7 @@ }, "queued": { "descriptionHtml": "A job in a workflow run was created.
", - "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -160116,7 +165390,7 @@ }, "waiting": { "descriptionHtml": "A job in a workflow run was created and is waiting for approvals.
", - "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow.
\nFor more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, see the workflow_run event.
To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.
", + "summaryHtml": "This event occurs when there is activity relating to a job in a GitHub Actions workflow.
\nFor more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see the REST API documentation.
\nFor activity relating to a workflow run instead of a job in a workflow run, see the workflow_run event.
To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.
", "bodyParameters": [ { "type": "string", @@ -160872,7 +166146,7 @@ "workflow_run": { "completed": { "descriptionHtml": "A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
", - "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -161010,7 +166284,7 @@ }, "in_progress": { "descriptionHtml": "A workflow run started processing on a runner.
", - "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", @@ -161148,7 +166422,7 @@ }, "requested": { "descriptionHtml": "A workflow run was triggered.
", - "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", + "summaryHtml": "This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.
\nFor activity relating to a job in a workflow run, use the workflow_job event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.
", "bodyParameters": [ { "type": "string", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index f095425375..b84f212e24 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "af631f687d9e4aedb65f9351d66a955b63f56f15" + "sha": "81e9e12dff09bb5cf8098d46f401a238cc73c851" } \ No newline at end of file