| permission | no |
diff --git a/docs/users/listBlockedByAuthenticated.md b/docs/users/listBlockedByAuthenticated.md
index 045fcceb4..a2415d7f3 100644
--- a/docs/users/listBlockedByAuthenticated.md
+++ b/docs/users/listBlockedByAuthenticated.md
@@ -18,26 +18,6 @@ octokit.rest.users.listBlockedByAuthenticated();
## Parameters
-
-
-
- | name |
- required |
- description |
-
-
-
- | per_page | no |
-
-The number of results per page (max 100).
-
- |
-| page | no |
-
-Page number of the results to fetch.
-
- |
-
-
+This endpoint has no parameters
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user).
diff --git a/docs/users/listBlockedByAuthenticatedUser.md b/docs/users/listBlockedByAuthenticatedUser.md
index 0c592f98c..485e0e967 100644
--- a/docs/users/listBlockedByAuthenticatedUser.md
+++ b/docs/users/listBlockedByAuthenticatedUser.md
@@ -16,26 +16,6 @@ octokit.rest.users.listBlockedByAuthenticatedUser();
## Parameters
-
-
-
- | name |
- required |
- description |
-
-
-
- | per_page | no |
-
-The number of results per page (max 100).
-
- |
-| page | no |
-
-Page number of the results to fetch.
-
- |
-
-
+This endpoint has no parameters
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user).
diff --git a/package-lock.json b/package-lock.json
index 024272703..fcd304cc6 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
"version": "0.0.0-development",
"license": "MIT",
"dependencies": {
- "@octokit/types": "^8.2.0",
+ "@octokit/types": "^8.1.1",
"deprecation": "^2.3.1"
},
"devDependencies": {
@@ -2683,9 +2683,9 @@
}
},
"node_modules/@octokit/openapi-types": {
- "version": "16.0.0",
- "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-16.0.0.tgz",
- "integrity": "sha512-JbFWOqTJVLHZSUUoF4FzAZKYtqdxWu9Z5m2QQnOyEa04fOFljvyh7D3GYKbfuaSWisqehImiVIMG4eyJeP5VEA=="
+ "version": "14.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz",
+ "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw=="
},
"node_modules/@octokit/request": {
"version": "6.2.2",
@@ -2719,11 +2719,11 @@
}
},
"node_modules/@octokit/types": {
- "version": "8.2.0",
- "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.0.tgz",
- "integrity": "sha512-v40LBJjw973X7sP6CuldlXDwIdgmVhry3Jq4jveVJgN1XBhqpCEDYTyDeXW/YS0bBGN3CRvTvON5IvZpaxcu0g==",
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.1.1.tgz",
+ "integrity": "sha512-7tjk+6DyhYAmei8FOEwPfGKc0VE1x56CKPJ+eE44zhDbOyMT+9yan8apfQFxo8oEFsy+0O7PiBtH8w0Yo0Y9Kw==",
"dependencies": {
- "@octokit/openapi-types": "^16.0.0"
+ "@octokit/openapi-types": "^14.0.0"
}
},
"node_modules/@pika/babel-plugin-esm-import-rewrite": {
@@ -11224,9 +11224,9 @@
}
},
"@octokit/openapi-types": {
- "version": "16.0.0",
- "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-16.0.0.tgz",
- "integrity": "sha512-JbFWOqTJVLHZSUUoF4FzAZKYtqdxWu9Z5m2QQnOyEa04fOFljvyh7D3GYKbfuaSWisqehImiVIMG4eyJeP5VEA=="
+ "version": "14.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz",
+ "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw=="
},
"@octokit/request": {
"version": "6.2.2",
@@ -11254,11 +11254,11 @@
}
},
"@octokit/types": {
- "version": "8.2.0",
- "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.0.tgz",
- "integrity": "sha512-v40LBJjw973X7sP6CuldlXDwIdgmVhry3Jq4jveVJgN1XBhqpCEDYTyDeXW/YS0bBGN3CRvTvON5IvZpaxcu0g==",
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.1.1.tgz",
+ "integrity": "sha512-7tjk+6DyhYAmei8FOEwPfGKc0VE1x56CKPJ+eE44zhDbOyMT+9yan8apfQFxo8oEFsy+0O7PiBtH8w0Yo0Y9Kw==",
"requires": {
- "@octokit/openapi-types": "^16.0.0"
+ "@octokit/openapi-types": "^14.0.0"
}
},
"@pika/babel-plugin-esm-import-rewrite": {
diff --git a/package.json b/package.json
index c9a164a21..cc25bfdcf 100644
--- a/package.json
+++ b/package.json
@@ -24,7 +24,7 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"dependencies": {
- "@octokit/types": "^8.2.0",
+ "@octokit/types": "^8.1.1",
"deprecation": "^2.3.1"
},
"devDependencies": {
diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
index b4ce60ffd..8002c67c3 100644
--- a/scripts/update-endpoints/generated/endpoints.json
+++ b/scripts/update-endpoints/generated/endpoints.json
@@ -226,131 +226,6 @@
],
"renamed": null
},
- {
- "name": "Add selected repository to an organization variable",
- "scope": "actions",
- "id": "addSelectedRepoToOrgVariable",
- "method": "PUT",
- "url": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Response", "examples": null },
- {
- "code": 409,
- "description": "Response when the visibility of the variable is not set to `selected`",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Add a repository to a required workflow",
- "scope": "actions",
- "id": "addSelectedRepoToRequiredWorkflow",
- "method": "PUT",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#add-a-repository-to-selected-repositories-list-for-a-required-workflow",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Success", "examples": null },
- { "code": 404, "description": "Resource Not Found", "examples": null },
- { "code": 422, "description": "Validation Error", "examples": null }
- ],
- "renamed": null
- },
{
"name": "Approve a workflow run for a fork pull request",
"scope": "actions",
@@ -480,82 +355,6 @@
],
"renamed": null
},
- {
- "name": "Create an environment variable",
- "scope": "actions",
- "id": "createEnvironmentVariable",
- "method": "POST",
- "url": "/repositories/{repository_id}/environments/{environment_name}/variables",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-environment-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "environment_name",
- "description": "The name of the environment.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "value",
- "description": "The value of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- }
- ],
- "renamed": null
- },
{
"name": "Create or update an environment secret",
"scope": "actions",
@@ -565,7 +364,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-an-environment-secret",
"previews": [],
"headers": [],
@@ -766,7 +565,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/actions#create-or-update-a-repository-secret",
"previews": [],
"headers": [],
@@ -851,95 +650,6 @@
],
"renamed": null
},
- {
- "name": "Create an organization variable",
- "scope": "actions",
- "id": "createOrgVariable",
- "method": "POST",
- "url": "/orgs/{org}/actions/variables",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Creates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#create-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "value",
- "description": "The value of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "visibility",
- "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": ["all", "private", "selected"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "selected_repository_ids",
- "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.",
- "in": "BODY",
- "type": "integer[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response when creating a variable",
- "examples": [{ "data": "null" }]
- }
- ],
- "renamed": null
- },
{
"name": "Create a registration token for an organization",
"scope": "actions",
@@ -1131,190 +841,16 @@
"renamed": null
},
{
- "name": "Create a repository variable",
+ "name": "Create a workflow dispatch event",
"scope": "actions",
- "id": "createRepoVariable",
+ "id": "createWorkflowDispatch",
"method": "POST",
- "url": "/repos/{owner}/{repo}/actions/variables",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#create-a-repository-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "value",
- "description": "The value of the variable.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- }
- ],
- "renamed": null
- },
- {
- "name": "Create a required workflow",
- "scope": "actions",
- "id": "createRequiredWorkflow",
- "method": "POST",
- "url": "/orgs/{org}/actions/required_workflows",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Create a required workflow in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-required-workflow",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "workflow_file_path",
- "description": "Path of the workflow file to be configured as a required workflow.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "The ID of the repository that contains the workflow file.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "scope",
- "description": "Enable the required workflow for all repositories or selected repositories in the organization.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["selected", "all"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "selected_repository_ids",
- "description": "A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`.",
- "in": "BODY",
- "type": "integer[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [
- {
- "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}"
- }
- ]
- },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Create a workflow dispatch event",
- "scope": "actions",
- "id": "createWorkflowDispatch",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event",
+ "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#create-a-workflow-dispatch-event",
"previews": [],
"headers": [],
"parameters": [
@@ -1654,24 +1190,24 @@
"renamed": null
},
{
- "name": "Delete an environment variable",
+ "name": "Delete an organization secret",
"scope": "actions",
- "id": "deleteEnvironmentVariable",
+ "id": "deleteOrgSecret",
"method": "DELETE",
- "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
+ "url": "/orgs/{org}/actions/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes an environment variable using the variable name.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-environment-variable",
+ "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-an-organization-secret",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -1681,8 +1217,8 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "secret_name",
+ "description": "The name of the secret.",
"in": "PATH",
"type": "string",
"required": true,
@@ -1698,22 +1234,35 @@
"renamed": null
},
{
- "name": "Delete an organization secret",
+ "name": "Delete a repository secret",
"scope": "actions",
- "id": "deleteOrgSecret",
+ "id": "deleteRepoSecret",
"method": "DELETE",
- "url": "/orgs/{org}/actions/secrets/{secret_name}",
+ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-an-organization-secret",
+ "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-repository-secret",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -1742,16 +1291,16 @@
"renamed": null
},
{
- "name": "Delete an organization variable",
+ "name": "Delete a self-hosted runner from an organization",
"scope": "actions",
- "id": "deleteOrgVariable",
+ "id": "deleteSelfHostedRunnerFromOrg",
"method": "DELETE",
- "url": "/orgs/{org}/actions/variables/{name}",
+ "url": "/orgs/{org}/actions/runners/{runner_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes an organization variable using the variable name.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-an-organization-variable",
+ "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -1769,8 +1318,52 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Delete a self-hosted runner from a repository",
+ "scope": "actions",
+ "id": "deleteSelfHostedRunnerFromRepo",
+ "method": "DELETE",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -1780,22 +1373,35 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Delete a repository secret",
+ "name": "Delete a workflow run",
"scope": "actions",
- "id": "deleteRepoSecret",
+ "id": "deleteWorkflowRun",
"method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-repository-secret",
+ "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-workflow-run",
"previews": [],
"headers": [],
"parameters": [
@@ -1826,10 +1432,10 @@
"deprecated": null
},
{
- "name": "secret_name",
- "description": "The name of the secret.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -1843,16 +1449,16 @@
"renamed": null
},
{
- "name": "Delete a repository variable",
+ "name": "Delete workflow run logs",
"scope": "actions",
- "id": "deleteRepoVariable",
+ "id": "deleteWorkflowRunLogs",
"method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/variables/{name}",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a repository variable using the variable name.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#delete-a-repository-variable",
+ "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-workflow-run-logs",
"previews": [],
"headers": [],
"parameters": [
@@ -1883,10 +1489,10 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -1896,20 +1502,24 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ { "code": 204, "description": "Response", "examples": null },
+ { "code": 403, "description": "Forbidden", "examples": null },
+ { "code": 500, "description": "Internal Error", "examples": null }
+ ],
"renamed": null
},
{
- "name": "Delete a required workflow",
+ "name": "Disable a selected repository for GitHub Actions in an organization",
"scope": "actions",
- "id": "deleteRequiredWorkflow",
+ "id": "disableSelectedRepositoryGithubActionsOrganization",
"method": "DELETE",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}",
+ "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a required workflow configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-required-workflow",
+ "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -1927,8 +1537,8 @@
"deprecated": null
},
{
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
+ "name": "repository_id",
+ "description": "The unique identifier of the repository.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -1944,22 +1554,22 @@
"renamed": null
},
{
- "name": "Delete a self-hosted runner from an organization",
+ "name": "Disable a workflow",
"scope": "actions",
- "id": "deleteSelfHostedRunnerFromOrg",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/runners/{runner_id}",
+ "id": "disableWorkflow",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization",
+ "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-workflow",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -1971,10 +1581,23 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "workflow_id",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "in": "PATH",
+ "type": null,
"required": true,
"enum": null,
"allowNull": false,
@@ -1988,16 +1611,16 @@
"renamed": null
},
{
- "name": "Delete a self-hosted runner from a repository",
+ "name": "Download an artifact",
"scope": "actions",
- "id": "deleteSelfHostedRunnerFromRepo",
- "method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}",
+ "id": "downloadArtifact",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository",
+ "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#download-an-artifact",
"previews": [],
"headers": [],
"parameters": [
@@ -2028,8 +1651,8 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "artifact_id",
+ "description": "The unique identifier of the artifact.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -2039,22 +1662,38 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "archive_format",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ { "code": 302, "description": "Response", "examples": null },
+ { "code": 410, "description": "Gone", "examples": null }
+ ],
"renamed": null
},
{
- "name": "Delete a workflow run",
+ "name": "Download job logs for a workflow run",
"scope": "actions",
- "id": "deleteWorkflowRun",
- "method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}",
+ "id": "downloadJobLogsForWorkflowRun",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-a-workflow-run",
+ "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run",
"previews": [],
"headers": [],
"parameters": [
@@ -2085,8 +1724,8 @@
"deprecated": null
},
{
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
+ "name": "job_id",
+ "description": "The unique identifier of the job.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -2098,20 +1737,20 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Delete workflow run logs",
+ "name": "Download workflow run attempt logs",
"scope": "actions",
- "id": "deleteWorkflowRunLogs",
- "method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
+ "id": "downloadWorkflowRunAttemptLogs",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#delete-workflow-run-logs",
+ "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs",
"previews": [],
"headers": [],
"parameters": [
@@ -2153,32 +1792,41 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
- "responses": [
- { "code": 204, "description": "Response", "examples": null },
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 500, "description": "Internal Error", "examples": null }
- ],
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Disable a selected repository for GitHub Actions in an organization",
+ "name": "Download workflow run logs",
"scope": "actions",
- "id": "disableSelectedRepositoryGithubActionsOrganization",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}",
+ "id": "downloadWorkflowRunLogs",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization",
+ "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-logs",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -2190,8 +1838,21 @@
"deprecated": null
},
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -2203,39 +1864,26 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Disable a workflow",
+ "name": "Enable a selected repository for GitHub Actions in an organization",
"scope": "actions",
- "id": "disableWorkflow",
+ "id": "enableSelectedRepositoryGithubActionsOrganization",
"method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable",
+ "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-workflow",
+ "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -2247,10 +1895,10 @@
"deprecated": null
},
{
- "name": "workflow_id",
- "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "name": "repository_id",
+ "description": "The unique identifier of the repository.",
"in": "PATH",
- "type": null,
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -2264,16 +1912,16 @@
"renamed": null
},
{
- "name": "Download an artifact",
+ "name": "Enable a workflow",
"scope": "actions",
- "id": "downloadArtifact",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}",
+ "id": "enableWorkflow",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#download-an-artifact",
+ "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-workflow",
"previews": [],
"headers": [],
"parameters": [
@@ -2304,23 +1952,10 @@
"deprecated": null
},
{
- "name": "artifact_id",
- "description": "The unique identifier of the artifact.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "archive_format",
- "description": "",
+ "name": "workflow_id",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
"in": "PATH",
- "type": "string",
+ "type": null,
"required": true,
"enum": null,
"allowNull": false,
@@ -2330,308 +1965,20 @@
"deprecated": null
}
],
- "responses": [
- { "code": 302, "description": "Response", "examples": null },
- { "code": 410, "description": "Gone", "examples": null }
- ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Download job logs for a workflow run",
+ "name": "List GitHub Actions caches for a repository",
"scope": "actions",
- "id": "downloadJobLogsForWorkflowRun",
+ "id": "getActionsCacheList",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
+ "url": "/repos/{owner}/{repo}/actions/caches",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#download-job-logs-for-a-workflow-run",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "job_id",
- "description": "The unique identifier of the job.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 302, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Download workflow run attempt logs",
- "scope": "actions",
- "id": "downloadWorkflowRunAttemptLogs",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "attempt_number",
- "description": "The attempt number of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 302, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Download workflow run logs",
- "scope": "actions",
- "id": "downloadWorkflowRunLogs",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#download-workflow-run-logs",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 302, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Enable a selected repository for GitHub Actions in an organization",
- "scope": "actions",
- "id": "enableSelectedRepositoryGithubActionsOrganization",
- "method": "PUT",
- "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Enable a workflow",
- "scope": "actions",
- "id": "enableWorkflow",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#enable-a-workflow",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "workflow_id",
- "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
- "in": "PATH",
- "type": null,
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "List GitHub Actions caches for a repository",
- "scope": "actions",
- "id": "getActionsCacheList",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/caches",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists the GitHub Actions caches for a repository.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository",
+ "description": "Lists the GitHub Actions caches for a repository.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -2874,6 +2221,47 @@
],
"renamed": null
},
+ {
+ "name": "Get GitHub Actions cache usage for an enterprise",
+ "scope": "actions",
+ "id": "getActionsCacheUsageForEnterprise",
+ "method": "GET",
+ "url": "/enterprises/{enterprise}/actions/cache/usage",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets the total GitHub Actions cache usage for an enterprise.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_active_caches_size_in_bytes\":3344284,\"total_active_caches_count\":5}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
{
"name": "Get GitHub Actions cache usage for an organization",
"scope": "actions",
@@ -3199,48 +2587,22 @@
"renamed": null
},
{
- "name": "Get an environment variable",
+ "name": "Get default workflow permissions for an enterprise",
"scope": "actions",
- "id": "getEnvironmentVariable",
+ "id": "getGithubActionsDefaultWorkflowPermissionsEnterprise",
"method": "GET",
- "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
+ "url": "/enterprises/{enterprise}/actions/permissions/workflow",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-environment-variable",
+ "description": "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](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-default-workflow-permissions-for-an-enterprise",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "environment_name",
- "description": "The name of the environment.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"in": "PATH",
"type": "string",
"required": true,
@@ -3255,10 +2617,10 @@
"responses": [
{
"code": 200,
- "description": "Response",
+ "description": "Success response",
"examples": [
{
- "data": "{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2022-01-10T14:59:22Z\"}"
+ "data": "{\"default_workflow_permissions\":\"read\",\"can_approve_pull_request_reviews\":true}"
}
]
}
@@ -3515,7 +2877,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}"
+ "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}"
}
]
}
@@ -3617,60 +2979,6 @@
],
"renamed": null
},
- {
- "name": "Get an organization variable",
- "scope": "actions",
- "id": "getOrgVariable",
- "method": "GET",
- "url": "/orgs/{org}/actions/variables/{name}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#get-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories\"}"
- }
- ]
- }
- ],
- "renamed": null
- },
{
"name": "Get pending deployments for a workflow run",
"scope": "actions",
@@ -3855,22 +3163,22 @@
"renamed": null
},
{
- "name": "Get a required workflow entity for a repository",
+ "name": "Get a repository secret",
"scope": "actions",
- "id": "getRepoRequiredWorkflow",
+ "id": "getRepoSecret",
"method": "GET",
- "url": "/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}",
+ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific required workflow present in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-repository-required-workflow",
+ "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-secret",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -3895,10 +3203,10 @@
"deprecated": null
},
{
- "name": "required_workflow_id_for_repo",
- "description": "The ID of the required workflow that has run at least once in a repository.",
+ "name": "secret_name",
+ "description": "The name of the secret.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -3914,31 +3222,30 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"RequiredCI\",\"path\":\".github/workflows/required_ci.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg\",\"source_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octo-org/Hello-World\",\"owner\":{\"login\":\"octo-org\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octo-org_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octo-org/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octo-org/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octo-org/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octo-org/Hello-World/hooks\"}}"
+ "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}"
}
]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
+ }
],
"renamed": null
},
{
- "name": "Get required workflow usage",
+ "name": "Get the review history for a workflow run",
"scope": "actions",
- "id": "getRepoRequiredWorkflowUsage",
+ "id": "getReviewsForRun",
"method": "GET",
- "url": "/repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the number of billable minutes used by a specific required workflow during the current billing cycle.\n\nBillable minutes only apply to required workflows running in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions).\"\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-repository-required-workflow-usage",
+ "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -3963,8 +3270,8 @@
"deprecated": null
},
{
- "name": "required_workflow_id_for_repo",
- "description": "The ID of the required workflow that has run at least once in a repository.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -3982,25 +3289,78 @@
"description": "Response",
"examples": [
{
- "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}"
+ "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
}
]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Get a self-hosted runner for an organization",
+ "scope": "actions",
+ "id": "getSelfHostedRunnerForOrg",
+ "method": "GET",
+ "url": "/orgs/{org}/actions/runners/{runner_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
},
- { "code": 404, "description": "Resource not found", "examples": null }
+ {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ }
+ ]
+ }
],
"renamed": null
},
{
- "name": "Get a repository secret",
+ "name": "Get a self-hosted runner for a repository",
"scope": "actions",
- "id": "getRepoSecret",
+ "id": "getSelfHostedRunnerForRepo",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-repository-secret",
+ "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -4031,10 +3391,10 @@
"deprecated": null
},
{
- "name": "secret_name",
- "description": "The name of the secret.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -4050,7 +3410,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}"
+ "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
}
]
}
@@ -4058,16 +3418,16 @@
"renamed": null
},
{
- "name": "Get a repository variable",
+ "name": "Get a workflow",
"scope": "actions",
- "id": "getRepoVariable",
+ "id": "getWorkflow",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/variables/{name}",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#get-a-repository-variable",
+ "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow",
"previews": [],
"headers": [],
"parameters": [
@@ -4098,10 +3458,10 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "workflow_id",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
"in": "PATH",
- "type": "string",
+ "type": null,
"required": true,
"enum": null,
"allowNull": false,
@@ -4117,7 +3477,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2021-08-10T14:59:22Z\",\"updated_at\":\"2022-01-10T14:59:22Z\"}"
+ "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}"
}
]
}
@@ -4125,22 +3485,22 @@
"renamed": null
},
{
- "name": "Get a required workflow",
+ "name": "Get the level of access for workflows outside of the repository",
"scope": "actions",
- "id": "getRequiredWorkflow",
+ "id": "getWorkflowAccessToRepository",
"method": "GET",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}",
+ "url": "/repos/{owner}/{repo}/actions/permissions/access",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Get a required workflow configured in an organization.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-required-workflow",
+ "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -4152,8 +3512,71 @@
"deprecated": null
},
{
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [{ "data": "{\"access_level\":\"organization\"}" }]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Get a workflow run",
+ "scope": "actions",
+ "id": "getWorkflowRun",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -4163,6 +3586,19 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "exclude_pull_requests",
+ "description": "If `true` pull requests are omitted from the response (empty array).",
+ "in": "QUERY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -4171,7 +3607,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}"
+ "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}"
}
]
}
@@ -4179,16 +3615,16 @@
"renamed": null
},
{
- "name": "Get the review history for a workflow run",
+ "name": "Get a workflow run attempt",
"scope": "actions",
- "id": "getReviewsForRun",
+ "id": "getWorkflowRunAttempt",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-the-review-history-for-a-workflow-run",
+ "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt",
"previews": [],
"headers": [],
"parameters": [
@@ -4230,40 +3666,12 @@
"validation": null,
"alias": null,
"deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "Get a self-hosted runner for an organization",
- "scope": "actions",
- "id": "getSelfHostedRunnerForOrg",
- "method": "GET",
- "url": "/orgs/{org}/actions/runners/{runner_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
+ },
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -4273,11 +3681,11 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
- "in": "PATH",
- "type": "integer",
- "required": true,
+ "name": "exclude_pull_requests",
+ "description": "If `true` pull requests are omitted from the response (empty array).",
+ "in": "QUERY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -4292,7 +3700,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}"
}
]
}
@@ -4300,16 +3708,16 @@
"renamed": null
},
{
- "name": "Get a self-hosted runner for a repository",
+ "name": "Get workflow run usage",
"scope": "actions",
- "id": "getSelfHostedRunnerForRepo",
+ "id": "getWorkflowRunUsage",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-self-hosted-runner-for-a-repository",
+ "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage",
"previews": [],
"headers": [],
"parameters": [
@@ -4340,8 +3748,8 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -4359,7 +3767,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}"
}
]
}
@@ -4367,16 +3775,16 @@
"renamed": null
},
{
- "name": "Get a workflow",
+ "name": "Get workflow usage",
"scope": "actions",
- "id": "getWorkflow",
+ "id": "getWorkflowUsage",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow",
+ "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage",
"previews": [],
"headers": [],
"parameters": [
@@ -4426,7 +3834,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}"
+ "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}"
}
]
}
@@ -4434,16 +3842,16 @@
"renamed": null
},
{
- "name": "Get the level of access for workflows outside of the repository",
+ "name": "List artifacts for a repository",
"scope": "actions",
- "id": "getWorkflowAccessToRepository",
+ "id": "listArtifactsForRepo",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/permissions/access",
+ "url": "/repos/{owner}/{repo}/actions/artifacts",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-access-level-to-a-repository",
+ "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -4472,36 +3880,66 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
{
"code": 200,
"description": "Response",
- "examples": [{ "data": "{\"access_level\":\"organization\"}" }]
+ "examples": [
+ {
+ "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}"
+ }
+ ]
}
],
"renamed": null
},
{
- "name": "Get a workflow run",
+ "name": "List environment secrets",
"scope": "actions",
- "id": "getWorkflowRun",
+ "id": "listEnvironmentSecrets",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}",
+ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run",
+ "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "repository_id",
+ "description": "The unique identifier of the repository.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -4511,8 +3949,8 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "environment_name",
+ "description": "The name of the environment.",
"in": "PATH",
"type": "string",
"required": true,
@@ -4524,11 +3962,11 @@
"deprecated": null
},
{
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
"type": "integer",
- "required": true,
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -4537,10 +3975,10 @@
"deprecated": null
},
{
- "name": "exclude_pull_requests",
- "description": "If `true` pull requests are omitted from the response (empty array).",
+ "name": "page",
+ "description": "Page number of the results to fetch.",
"in": "QUERY",
- "type": "boolean",
+ "type": "integer",
"required": false,
"enum": null,
"allowNull": false,
@@ -4556,7 +3994,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}"
+ "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
}
]
}
@@ -4564,16 +4002,16 @@
"renamed": null
},
{
- "name": "Get a workflow run attempt",
+ "name": "List jobs for a workflow run",
"scope": "actions",
- "id": "getWorkflowRunAttempt",
+ "id": "listJobsForWorkflowRun",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt",
+ "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run",
"previews": [],
"headers": [],
"parameters": [
@@ -4617,11 +4055,24 @@
"deprecated": null
},
{
- "name": "attempt_number",
- "description": "The attempt number of the workflow run.",
- "in": "PATH",
+ "name": "filter",
+ "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": ["latest", "all"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
"type": "integer",
- "required": true,
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -4630,10 +4081,10 @@
"deprecated": null
},
{
- "name": "exclude_pull_requests",
- "description": "If `true` pull requests are omitted from the response (empty array).",
+ "name": "page",
+ "description": "Page number of the results to fetch.",
"in": "QUERY",
- "type": "boolean",
+ "type": "integer",
"required": false,
"enum": null,
"allowNull": false,
@@ -4649,7 +4100,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"display_title\":\"Update README.md\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"referenced_workflows\":[{\"path\":\"octocat/Hello-World/.github/workflows/deploy.yml@main\",\"sha\":\"86e8bc9ecf7d38b1ed2d2cfb8eb87ba9b35b01db\",\"ref\":\"refs/heads/main\"},{\"path\":\"octo-org/octo-repo/.github/workflows/report.yml@v2\",\"sha\":\"79e9790903e1c3373b1a3e3a941d57405478a232\",\"ref\":\"refs/tags/v2\"},{\"path\":\"octo-org/octo-repo/.github/workflows/secure.yml@1595d4b6de6a9e9751fb270a41019ce507d4099e\",\"sha\":\"1595d4b6de6a9e9751fb270a41019ce507d4099e\"}],\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"previous_attempt_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/attempts/1\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}"
+ "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}"
}
]
}
@@ -4657,16 +4108,16 @@
"renamed": null
},
{
- "name": "Get workflow run usage",
+ "name": "List jobs for a workflow run attempt",
"scope": "actions",
- "id": "getWorkflowRunUsage",
+ "id": "listJobsForWorkflowRunAttempt",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-run-usage",
+ "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt",
"previews": [],
"headers": [],
"parameters": [
@@ -4708,6 +4159,45 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "attempt_number",
+ "description": "The attempt number of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -4716,43 +4206,31 @@
"description": "Response",
"examples": [
{
- "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000,\"jobs\":1,\"job_runs\":[{\"job_id\":1,\"duration_ms\":180000}]},\"MACOS\":{\"total_ms\":240000,\"jobs\":4,\"job_runs\":[{\"job_id\":2,\"duration_ms\":60000},{\"job_id\":3,\"duration_ms\":60000},{\"job_id\":4,\"duration_ms\":60000},{\"job_id\":5,\"duration_ms\":60000}]},\"WINDOWS\":{\"total_ms\":300000,\"jobs\":2,\"job_runs\":[{\"job_id\":6,\"duration_ms\":150000},{\"job_id\":7,\"duration_ms\":150000}]}},\"run_duration_ms\":500000}"
+ "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}"
}
]
- }
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
{
- "name": "Get workflow usage",
+ "name": "List labels for a self-hosted runner for an organization",
"scope": "actions",
- "id": "getWorkflowUsage",
+ "id": "listLabelsForSelfHostedRunnerForOrg",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing",
+ "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#get-workflow-usage",
+ "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -4764,10 +4242,10 @@
"deprecated": null
},
{
- "name": "workflow_id",
- "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
"in": "PATH",
- "type": null,
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -4783,24 +4261,25 @@
"description": "Response",
"examples": [
{
- "data": "{\"billable\":{\"UBUNTU\":{\"total_ms\":180000},\"MACOS\":{\"total_ms\":240000},\"WINDOWS\":{\"total_ms\":300000}}}"
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
}
]
- }
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
{
- "name": "List artifacts for a repository",
+ "name": "List labels for a self-hosted runner for a repository",
"scope": "actions",
- "id": "listArtifactsForRepo",
+ "id": "listLabelsForSelfHostedRunnerForRepo",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/artifacts",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-artifacts-for-a-repository",
+ "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -4831,37 +4310,11 @@
"deprecated": null
},
{
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
"type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "Filters artifacts by exact match on their name field.",
- "in": "QUERY",
- "type": "string",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -4876,43 +4329,31 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}"
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
}
]
- }
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
{
- "name": "List environment secrets",
+ "name": "List organization secrets",
"scope": "actions",
- "id": "listEnvironmentSecrets",
+ "id": "listOrgSecrets",
"method": "GET",
- "url": "/repositories/{repository_id}/environments/{environment_name}/secrets",
+ "url": "/orgs/{org}/actions/secrets",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-environment-secrets",
+ "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "environment_name",
- "description": "The name of the environment.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -4956,7 +4397,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
+ "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}"
}
]
}
@@ -4964,24 +4405,24 @@
"renamed": null
},
{
- "name": "List environment variables",
+ "name": "List repository secrets",
"scope": "actions",
- "id": "listEnvironmentVariables",
+ "id": "listRepoSecrets",
"method": "GET",
- "url": "/repositories/{repository_id}/environments/{environment_name}/variables",
+ "url": "/repos/{owner}/{repo}/actions/secrets",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#list-environment-variables",
+ "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-secrets",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -4991,8 +4432,8 @@
"deprecated": null
},
{
- "name": "environment_name",
- "description": "The name of the environment.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5005,7 +4446,7 @@
},
{
"name": "per_page",
- "description": "The number of results per page (max 30).",
+ "description": "The number of results per page (max 100).",
"in": "QUERY",
"type": "integer",
"required": false,
@@ -5036,7 +4477,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
+ "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
}
]
}
@@ -5044,16 +4485,16 @@
"renamed": null
},
{
- "name": "List jobs for a workflow run",
+ "name": "List repository workflows",
"scope": "actions",
- "id": "listJobsForWorkflowRun",
+ "id": "listRepoWorkflows",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
+ "url": "/repos/{owner}/{repo}/actions/workflows",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run",
+ "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-workflows",
"previews": [],
"headers": [],
"parameters": [
@@ -5083,32 +4524,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "filter",
- "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["latest", "all"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "per_page",
"description": "The number of results per page (max 100).",
@@ -5142,7 +4557,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}"
+ "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}"
}
]
}
@@ -5150,35 +4565,22 @@
"renamed": null
},
{
- "name": "List jobs for a workflow run attempt",
+ "name": "List runner applications for an organization",
"scope": "actions",
- "id": "listJobsForWorkflowRunAttempt",
+ "id": "listRunnerApplicationsForOrg",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs",
+ "url": "/orgs/{org}/actions/runners/downloads",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-jobs-for-a-workflow-run-attempt",
+ "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5188,58 +4590,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "attempt_number",
- "description": "The attempt number of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -5248,31 +4598,30 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\",\"workflow_name\":\"CI\",\"head_branch\":\"main\"}]}"
+ "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]"
}
]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
+ }
],
"renamed": null
},
{
- "name": "List labels for a self-hosted runner for an organization",
+ "name": "List runner applications for a repository",
"scope": "actions",
- "id": "listLabelsForSelfHostedRunnerForOrg",
+ "id": "listRunnerApplicationsForRepo",
"method": "GET",
- "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
+ "url": "/repos/{owner}/{repo}/actions/runners/downloads",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all labels for a self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization",
+ "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5284,10 +4633,10 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -5303,31 +4652,30 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]"
}
]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
+ }
],
"renamed": null
},
{
- "name": "List labels for a self-hosted runner for a repository",
+ "name": "List selected repositories for an organization secret",
"scope": "actions",
- "id": "listLabelsForSelfHostedRunnerForRepo",
+ "id": "listSelectedReposForOrgSecret",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
+ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository",
+ "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5339,8 +4687,8 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "secret_name",
+ "description": "The name of the secret.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5352,11 +4700,24 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
- "in": "PATH",
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
"type": "integer",
- "required": true,
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -5371,25 +4732,24 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}"
}
]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
+ }
],
"renamed": null
},
{
- "name": "List organization secrets",
+ "name": "List selected repositories enabled for GitHub Actions in an organization",
"scope": "actions",
- "id": "listOrgSecrets",
+ "id": "listSelectedRepositoriesEnabledGithubActionsOrganization",
"method": "GET",
- "url": "/orgs/{org}/actions/secrets",
+ "url": "/orgs/{org}/actions/permissions/repositories",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-organization-secrets",
+ "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -5439,7 +4799,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}"
+ "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}"
}
]
}
@@ -5447,16 +4807,16 @@
"renamed": null
},
{
- "name": "List organization variables",
+ "name": "List self-hosted runners for an organization",
"scope": "actions",
- "id": "listOrgVariables",
+ "id": "listSelfHostedRunnersForOrg",
"method": "GET",
- "url": "/orgs/{org}/actions/variables",
+ "url": "/orgs/{org}/actions/runners",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#list-organization-variables",
+ "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -5475,7 +4835,7 @@
},
{
"name": "per_page",
- "description": "The number of results per page (max 30).",
+ "description": "The number of results per page (max 100).",
"in": "QUERY",
"type": "integer",
"required": false,
@@ -5506,7 +4866,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":3,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"ACTIONS_RUNNER_DEBUG\",\"value\":true,\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"ADMIN_EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories\"}]}"
+ "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}"
}
]
}
@@ -5514,22 +4874,22 @@
"renamed": null
},
{
- "name": "List repository required workflows",
+ "name": "List self-hosted runners for a repository",
"scope": "actions",
- "id": "listRepoRequiredWorkflows",
+ "id": "listSelfHostedRunnersForRepo",
"method": "GET",
- "url": "/repos/{org}/{repo}/actions/required_workflows",
+ "url": "/repos/{owner}/{repo}/actions/runners",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists the required workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-required-workflows",
+ "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -5586,25 +4946,24 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":1,\"required_workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"RequiredCI\",\"path\":\".github/workflows/required_ci.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/required_workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/octo-org/hello-world/.github/workflows/required_ci.yaml\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/required/octo-org/hello-world/.github/workflows/required_ci.yaml/badge.svg\",\"source_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octo-org/Hello-World\",\"owner\":{\"login\":\"octo-org\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octo-org_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octo-org/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octo-org/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octo-org/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octo-org/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octo-org/Hello-World/hooks\"}}]}"
+ "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}"
}
]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
+ }
],
"renamed": null
},
{
- "name": "List repository secrets",
+ "name": "List workflow run artifacts",
"scope": "actions",
- "id": "listRepoSecrets",
+ "id": "listWorkflowRunArtifacts",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/secrets",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-secrets",
+ "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts",
"previews": [],
"headers": [],
"parameters": [
@@ -5634,6 +4993,19 @@
"alias": null,
"deprecated": null
},
+ {
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
{
"name": "per_page",
"description": "The number of results per page (max 100).",
@@ -5667,7 +5039,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
+ "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}"
}
]
}
@@ -5675,16 +5047,16 @@
"renamed": null
},
{
- "name": "List repository variables",
+ "name": "List workflow runs for a workflow",
"scope": "actions",
- "id": "listRepoVariables",
+ "id": "listWorkflowRuns",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/variables",
+ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#list-repository-variables",
+ "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs",
"previews": [],
"headers": [],
"parameters": [
@@ -5715,10 +5087,23 @@
"deprecated": null
},
{
- "name": "per_page",
- "description": "The number of results per page (max 30).",
+ "name": "workflow_id",
+ "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
+ "in": "PATH",
+ "type": null,
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "actor",
+ "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
"in": "QUERY",
- "type": "integer",
+ "type": "string",
"required": false,
"enum": null,
"allowNull": false,
@@ -5728,10 +5113,10 @@
"deprecated": null
},
{
- "name": "page",
- "description": "Page number of the results to fetch.",
+ "name": "branch",
+ "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.",
"in": "QUERY",
- "type": "integer",
+ "type": "string",
"required": false,
"enum": null,
"allowNull": false,
@@ -5739,41 +5124,13 @@
"validation": null,
"alias": null,
"deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":2,\"variables\":[{\"name\":\"USERNAME\",\"value\":\"octocat\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"EMAIL\",\"value\":\"octocat@github.com\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List repository workflows",
- "scope": "actions",
- "id": "listRepoWorkflows",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/workflows",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-repository-workflows",
- "previews": [],
- "headers": [],
- "parameters": [
+ },
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
+ "name": "event",
+ "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
+ "in": "QUERY",
"type": "string",
- "required": true,
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -5782,12 +5139,26 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
+ "name": "status",
+ "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
+ "in": "QUERY",
"type": "string",
- "required": true,
- "enum": null,
+ "required": false,
+ "enum": [
+ "completed",
+ "action_required",
+ "cancelled",
+ "failure",
+ "neutral",
+ "skipped",
+ "stale",
+ "success",
+ "timed_out",
+ "in_progress",
+ "queued",
+ "requested",
+ "waiting"
+ ],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -5819,6 +5190,58 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "created",
+ "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "exclude_pull_requests",
+ "description": "If `true` pull requests are omitted from the response (empty array).",
+ "in": "QUERY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "check_suite_id",
+ "description": "Returns workflow runs with the `check_suite_id` that you specify.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "head_sha",
+ "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -5827,7 +5250,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}"
+ "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}"
}
]
}
@@ -5835,16 +5258,16 @@
"renamed": null
},
{
- "name": "List workflow runs for a required workflow",
+ "name": "List workflow runs for a repository",
"scope": "actions",
- "id": "listRequiredWorkflowRuns",
+ "id": "listWorkflowRunsForRepo",
"method": "GET",
- "url": "/repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs",
+ "url": "/repos/{owner}/{repo}/actions/runs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List all workflow runs for a required workflow. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. For more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-required-workflow-runs",
+ "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -5874,19 +5297,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "required_workflow_id_for_repo",
- "description": "The ID of the required workflow that has run at least once in a repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "actor",
"description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
@@ -5915,7 +5325,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](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
+ "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
"in": "QUERY",
"type": "string",
"required": false,
@@ -6046,22 +5456,22 @@
"renamed": null
},
{
- "name": "List required workflows",
+ "name": "Re-run a job from a workflow run",
"scope": "actions",
- "id": "listRequiredWorkflows",
- "method": "GET",
- "url": "/orgs/{org}/actions/required_workflows",
+ "id": "reRunJobForWorkflowRun",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List all required workflows in an organization.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-required-workflows",
+ "description": "Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -6073,11 +5483,11 @@
"deprecated": null
},
{
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -6086,52 +5496,24 @@
"deprecated": null
},
{
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
+ "name": "job_id",
+ "description": "The unique identifier of the job.",
+ "in": "PATH",
"type": "integer",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":2,\"required_workflows\":[{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/organizations/org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}},{\"id\":30433643,\"name\":\"Required Linter\",\"path\":\".github/workflows/lint.yml\",\"scope\":\"all\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List runner applications for an organization",
- "scope": "actions",
- "id": "listRunnerApplicationsForOrg",
- "method": "GET",
- "url": "/orgs/{org}/actions/runners/downloads",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
+ },
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "name": "enable_debug_logging",
+ "description": "Whether to enable debug logging for the re-run.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -6142,28 +5524,25 @@
],
"responses": [
{
- "code": 200,
+ "code": 201,
"description": "Response",
- "examples": [
- {
- "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]"
- }
- ]
- }
+ "examples": [{ "data": "null" }]
+ },
+ { "code": 403, "description": "Forbidden", "examples": null }
],
"renamed": null
},
{
- "name": "List runner applications for a repository",
+ "name": "Re-run a workflow",
"scope": "actions",
- "id": "listRunnerApplicationsForRepo",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runners/downloads",
+ "id": "reRunWorkflow",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-runner-applications-for-a-repository",
+ "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow",
"previews": [],
"headers": [],
"parameters": [
@@ -6192,1339 +5571,10 @@
"validation": null,
"alias": null,
"deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List selected repositories for an organization secret",
- "scope": "actions",
- "id": "listSelectedReposForOrgSecret",
- "method": "GET",
- "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_name",
- "description": "The name of the secret.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List selected repositories for an organization variable",
- "scope": "actions",
- "id": "listSelectedReposForOrgVariable",
- "method": "GET",
- "url": "/orgs/{org}/actions/variables/{name}/repositories",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}"
- }
- ]
- },
- {
- "code": 409,
- "description": "Response when the visibility of the variable is not set to `selected`",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "List selected repositories enabled for GitHub Actions in an organization",
- "scope": "actions",
- "id": "listSelectedRepositoriesEnabledGithubActionsOrganization",
- "method": "GET",
- "url": "/orgs/{org}/actions/permissions/repositories",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List selected repositories for a required workflow",
- "scope": "actions",
- "id": "listSelectedRepositoriesRequiredWorkflow",
- "method": "GET",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-repositories-required-workflows",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Success",
- "examples": [
- {
- "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}"
- }
- ]
- },
- { "code": 404, "description": "Resource Not Found", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "List self-hosted runners for an organization",
- "scope": "actions",
- "id": "listSelfHostedRunnersForOrg",
- "method": "GET",
- "url": "/orgs/{org}/actions/runners",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List self-hosted runners for a repository",
- "scope": "actions",
- "id": "listSelfHostedRunnersForRepo",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runners",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-self-hosted-runners-for-a-repository",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List workflow run artifacts",
- "scope": "actions",
- "id": "listWorkflowRunArtifacts",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-run-artifacts",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332938,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"328faa0536e6fef19753d9d91dc96a9931694ce3\"}},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\",\"workflow_run\":{\"id\":2332942,\"repository_id\":1296269,\"head_repository_id\":1296269,\"head_branch\":\"main\",\"head_sha\":\"178f4f6090b3fccad4a65b3e83d076a622d59652\"}}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List workflow runs for a workflow",
- "scope": "actions",
- "id": "listWorkflowRuns",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "workflow_id",
- "description": "The ID of the workflow. You can also pass the workflow file name as a string.",
- "in": "PATH",
- "type": null,
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "actor",
- "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "branch",
- "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "event",
- "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "status",
- "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": [
- "completed",
- "action_required",
- "cancelled",
- "failure",
- "neutral",
- "skipped",
- "stale",
- "success",
- "timed_out",
- "in_progress",
- "queued",
- "requested",
- "waiting"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "created",
- "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "exclude_pull_requests",
- "description": "If `true` pull requests are omitted from the response (empty array).",
- "in": "QUERY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "check_suite_id",
- "description": "Returns workflow runs with the `check_suite_id` that you specify.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "head_sha",
- "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "List workflow runs for a repository",
- "scope": "actions",
- "id": "listWorkflowRunsForRepo",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/actions/runs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#list-workflow-runs-for-a-repository",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "actor",
- "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "branch",
- "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "event",
- "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "status",
- "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": [
- "completed",
- "action_required",
- "cancelled",
- "failure",
- "neutral",
- "skipped",
- "stale",
- "success",
- "timed_out",
- "in_progress",
- "queued",
- "requested",
- "waiting"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "created",
- "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "exclude_pull_requests",
- "description": "If `true` pull requests are omitted from the response (empty array).",
- "in": "QUERY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "check_suite_id",
- "description": "Returns workflow runs with the `check_suite_id` that you specify.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "head_sha",
- "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"run_attempt\":1,\"run_started_at\":\"2020-01-22T19:33:08Z\",\"triggering_actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "Re-run a job from a workflow run",
- "scope": "actions",
- "id": "reRunJobForWorkflowRun",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "job_id",
- "description": "The unique identifier of the job.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "enable_debug_logging",
- "description": "Whether to enable debug logging for the re-run.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- },
- { "code": 403, "description": "Forbidden", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "Re-run a workflow",
- "scope": "actions",
- "id": "reRunWorkflow",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-a-workflow",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "enable_debug_logging",
- "description": "Whether to enable debug logging for the re-run.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- }
- ],
- "renamed": null
- },
- {
- "name": "Re-run failed jobs from a workflow run",
- "scope": "actions",
- "id": "reRunWorkflowFailedJobs",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "enable_debug_logging",
- "description": "Whether to enable debug logging for the re-run.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- }
- ],
- "renamed": null
- },
- {
- "name": "Remove all custom labels from a self-hosted runner for an organization",
- "scope": "actions",
- "id": "removeAllCustomLabelsFromSelfHostedRunnerForOrg",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}"
- }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "Remove all custom labels from a self-hosted runner for a repository",
- "scope": "actions",
- "id": "removeAllCustomLabelsFromSelfHostedRunnerForRepo",
- "method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}"
- }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "Remove a custom label from a self-hosted runner for an organization",
- "scope": "actions",
- "id": "removeCustomLabelFromSelfHostedRunnerForOrg",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -7536,11 +5586,11 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of a self-hosted runner's custom label.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "name": "enable_debug_logging",
+ "description": "Whether to enable debug logging for the re-run.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -7551,34 +5601,24 @@
],
"responses": [
{
- "code": 200,
+ "code": 201,
"description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
- }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
+ "examples": [{ "data": "null" }]
}
],
"renamed": null
},
{
- "name": "Remove a custom label from a self-hosted runner for a repository",
+ "name": "Re-run failed jobs from a workflow run",
"scope": "actions",
- "id": "removeCustomLabelFromSelfHostedRunnerForRepo",
- "method": "DELETE",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}",
+ "id": "reRunWorkflowFailedJobs",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository",
+ "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs",
"previews": [],
"headers": [],
"parameters": [
@@ -7609,8 +5649,8 @@
"deprecated": null
},
{
- "name": "runner_id",
- "description": "Unique identifier of the self-hosted runner.",
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -7622,11 +5662,11 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of a self-hosted runner's custom label.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "name": "enable_debug_logging",
+ "description": "Whether to enable debug logging for the re-run.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -7637,166 +5677,24 @@
],
"responses": [
{
- "code": 200,
+ "code": 201,
"description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
- }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Remove selected repository from an organization secret",
- "scope": "actions",
- "id": "removeSelectedRepoFromOrgSecret",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_name",
- "description": "The name of the secret.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 204,
- "description": "Response when repository was removed from the selected list",
- "examples": null
- },
- {
- "code": 409,
- "description": "Conflict when visibility type not set to selected",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Remove selected repository from an organization variable",
- "scope": "actions",
- "id": "removeSelectedRepoFromOrgVariable",
- "method": "DELETE",
- "url": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "The name of the variable.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Response", "examples": null },
- {
- "code": 409,
- "description": "Response when the visibility of the variable is not set to `selected`",
- "examples": null
+ "examples": [{ "data": "null" }]
}
],
"renamed": null
},
{
- "name": "Remove a selected repository from required workflow",
+ "name": "Remove all custom labels from a self-hosted runner for an organization",
"scope": "actions",
- "id": "removeSelectedRepoFromRequiredWorkflow",
+ "id": "removeAllCustomLabelsFromSelfHostedRunnerForOrg",
"method": "DELETE",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}",
+ "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-repository-from-selected-repositories-list-for-a-required-workflow",
+ "description": "Remove all custom labels from a self-hosted runner configured in an\norganization. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -7814,82 +5712,8 @@
"deprecated": null
},
{
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Success", "examples": null },
- { "code": 404, "description": "Resource Not Found", "examples": null },
- { "code": 422, "description": "Validation Error", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "Review pending deployments for a workflow run",
- "scope": "actions",
- "id": "reviewPendingDeploymentsForRun",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "run_id",
- "description": "The unique identifier of the workflow run.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -7899,45 +5723,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "environment_ids",
- "description": "The list of environment ids to approve or reject",
- "in": "BODY",
- "type": "integer[]",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "state",
- "description": "Whether to approve or reject deployment to the specified environments.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": ["approved", "rejected"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "comment",
- "description": "A comment to accompany the deployment review",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -7946,129 +5731,34 @@
"description": "Response",
"examples": [
{
- "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]"
+ "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}"
}
]
- }
- ],
- "renamed": null
- },
- {
- "name": "Set allowed actions and reusable workflows for an organization",
- "scope": "actions",
- "id": "setAllowedActionsOrganization",
- "method": "PUT",
- "url": "/orgs/{org}/actions/permissions/selected-actions",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "github_owned_allowed",
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "verified_allowed",
- "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
},
- {
- "name": "patterns_allowed",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
- "in": "BODY",
- "type": "string[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Set allowed actions and reusable workflows for a repository",
+ "name": "Remove all custom labels from a self-hosted runner for a repository",
"scope": "actions",
- "id": "setAllowedActionsRepository",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions",
+ "id": "removeAllCustomLabelsFromSelfHostedRunnerForRepo",
+ "method": "DELETE",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository",
+ "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "github_owned_allowed",
- "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8077,11 +5767,11 @@
"deprecated": null
},
{
- "name": "verified_allowed",
- "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8090,11 +5780,11 @@
"deprecated": null
},
{
- "name": "patterns_allowed",
- "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
- "in": "BODY",
- "type": "string[]",
- "required": false,
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8103,20 +5793,31 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
"renamed": null
},
{
- "name": "Set custom labels for a self-hosted runner for an organization",
+ "name": "Remove a custom label from a self-hosted runner for an organization",
"scope": "actions",
- "id": "setCustomLabelsForSelfHostedRunnerForOrg",
- "method": "PUT",
- "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
+ "id": "removeCustomLabelFromSelfHostedRunnerForOrg",
+ "method": "DELETE",
+ "url": "/orgs/{org}/actions/runners/{runner_id}/labels/{name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization",
+ "description": "Remove a custom label from a self-hosted runner configured\nin an organization. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -8147,10 +5848,10 @@
"deprecated": null
},
{
- "name": "labels",
- "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
- "in": "BODY",
- "type": "string[]",
+ "name": "name",
+ "description": "The name of a self-hosted runner's custom label.",
+ "in": "PATH",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -8180,16 +5881,16 @@
"renamed": null
},
{
- "name": "Set custom labels for a self-hosted runner for a repository",
+ "name": "Remove a custom label from a self-hosted runner for a repository",
"scope": "actions",
- "id": "setCustomLabelsForSelfHostedRunnerForRepo",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
+ "id": "removeCustomLabelFromSelfHostedRunnerForRepo",
+ "method": "DELETE",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository",
+ "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -8233,10 +5934,10 @@
"deprecated": null
},
{
- "name": "labels",
- "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
- "in": "BODY",
- "type": "string[]",
+ "name": "name",
+ "description": "The name of a self-hosted runner's custom label.",
+ "in": "PATH",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -8266,16 +5967,16 @@
"renamed": null
},
{
- "name": "Set default workflow permissions for an organization",
+ "name": "Remove selected repository from an organization secret",
"scope": "actions",
- "id": "setGithubActionsDefaultWorkflowPermissionsOrganization",
- "method": "PUT",
- "url": "/orgs/{org}/actions/permissions/workflow",
+ "id": "removeSelectedRepoFromOrgSecret",
+ "method": "DELETE",
+ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions",
+ "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret",
"previews": [],
"headers": [],
"parameters": [
@@ -8293,12 +5994,12 @@
"deprecated": null
},
{
- "name": "default_workflow_permissions",
- "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
- "in": "BODY",
+ "name": "secret_name",
+ "description": "The name of the secret.",
+ "in": "PATH",
"type": "string",
- "required": false,
- "enum": ["read", "write"],
+ "required": true,
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8306,11 +6007,11 @@
"deprecated": null
},
{
- "name": "can_approve_pull_request_reviews",
- "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
+ "name": "repository_id",
+ "description": "",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8320,26 +6021,30 @@
}
],
"responses": [
- { "code": 204, "description": "Success response", "examples": null },
+ {
+ "code": 204,
+ "description": "Response when repository was removed from the selected list",
+ "examples": null
+ },
{
"code": 409,
- "description": "Conflict response when changing a setting is prevented by the owning enterprise",
+ "description": "Conflict when visibility type not set to selected",
"examples": null
}
],
"renamed": null
},
{
- "name": "Set default workflow permissions for a repository",
+ "name": "Review pending deployments for a workflow run",
"scope": "actions",
- "id": "setGithubActionsDefaultWorkflowPermissionsRepository",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/permissions/workflow",
+ "id": "reviewPendingDeploymentsForRun",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository",
+ "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nRequired reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#review-pending-deployments-for-a-workflow-run",
"previews": [],
"headers": [],
"parameters": [
@@ -8370,12 +6075,12 @@
"deprecated": null
},
{
- "name": "default_workflow_permissions",
- "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["read", "write"],
+ "name": "run_id",
+ "description": "The unique identifier of the workflow run.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8383,48 +6088,10 @@
"deprecated": null
},
{
- "name": "can_approve_pull_request_reviews",
- "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
+ "name": "environment_ids",
+ "description": "The list of environment ids to approve or reject",
"in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Success response", "examples": null },
- {
- "code": 409,
- "description": "Conflict response when changing a setting is prevented by the owning organization or enterprise",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Set GitHub Actions permissions for an organization",
- "scope": "actions",
- "id": "setGithubActionsPermissionsOrganization",
- "method": "PUT",
- "url": "/orgs/{org}/actions/permissions",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
+ "type": "integer[]",
"required": true,
"enum": null,
"allowNull": false,
@@ -8434,12 +6101,12 @@
"deprecated": null
},
{
- "name": "enabled_repositories",
- "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.",
+ "name": "state",
+ "description": "Whether to approve or reject deployment to the specified environments.",
"in": "BODY",
"type": "string",
"required": true,
- "enum": ["all", "none", "selected"],
+ "enum": ["approved", "rejected"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8447,12 +6114,12 @@
"deprecated": null
},
{
- "name": "allowed_actions",
- "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
+ "name": "comment",
+ "description": "A comment to accompany the deployment review",
"in": "BODY",
"type": "string",
- "required": false,
- "enum": ["all", "local_only", "selected"],
+ "required": true,
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8460,26 +6127,36 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]"
+ }
+ ]
+ }
+ ],
"renamed": null
},
{
- "name": "Set GitHub Actions permissions for a repository",
+ "name": "Set allowed actions and reusable workflows for an organization",
"scope": "actions",
- "id": "setGithubActionsPermissionsRepository",
+ "id": "setAllowedActionsOrganization",
"method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/permissions",
+ "url": "/orgs/{org}/actions/permissions/selected-actions",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository",
+ "description": "Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions and reusable workflows set at the enterprise level, then you cannot override any of the enterprise's allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -8491,11 +6168,11 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "name": "github_owned_allowed",
+ "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8504,11 +6181,11 @@
"deprecated": null
},
{
- "name": "enabled",
- "description": "Whether GitHub Actions is enabled on the repository.",
+ "name": "verified_allowed",
+ "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.",
"in": "BODY",
"type": "boolean",
- "required": true,
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8517,12 +6194,12 @@
"deprecated": null
},
{
- "name": "allowed_actions",
- "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
+ "name": "patterns_allowed",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"in": "BODY",
- "type": "string",
+ "type": "string[]",
"required": false,
- "enum": ["all", "local_only", "selected"],
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8534,22 +6211,22 @@
"renamed": null
},
{
- "name": "Set selected repositories for an organization secret",
+ "name": "Set allowed actions and reusable workflows for a repository",
"scope": "actions",
- "id": "setSelectedReposForOrgSecret",
+ "id": "setAllowedActionsRepository",
"method": "PUT",
- "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories",
+ "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret",
+ "description": "Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions and reusable workflows set at the organization or enterprise levels, then you cannot override any of the allowed actions and reusable workflows settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -8561,8 +6238,8 @@
"deprecated": null
},
{
- "name": "secret_name",
- "description": "The name of the secret.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -8574,42 +6251,11 @@
"deprecated": null
},
{
- "name": "selected_repository_ids",
- "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
+ "name": "github_owned_allowed",
+ "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
"in": "BODY",
- "type": "integer[]",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Set selected repositories for an organization variable",
- "scope": "actions",
- "id": "setSelectedReposForOrgVariable",
- "method": "PUT",
- "url": "/orgs/{org}/actions/variables/{name}/repositories",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8618,11 +6264,11 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
- "in": "PATH",
- "type": "string",
- "required": true,
+ "name": "verified_allowed",
+ "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8631,11 +6277,11 @@
"deprecated": null
},
{
- "name": "selected_repository_ids",
- "description": "The IDs of the repositories that can access the organization variable.",
+ "name": "patterns_allowed",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
"in": "BODY",
- "type": "integer[]",
- "required": true,
+ "type": "string[]",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -8644,27 +6290,20 @@
"deprecated": null
}
],
- "responses": [
- { "code": 204, "description": "Response", "examples": null },
- {
- "code": 409,
- "description": "Response when the visibility of the variable is not set to `selected`",
- "examples": null
- }
- ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Sets repositories for a required workflow",
+ "name": "Set custom labels for a self-hosted runner for an organization",
"scope": "actions",
- "id": "setSelectedReposToRequiredWorkflow",
+ "id": "setCustomLabelsForSelfHostedRunnerForOrg",
"method": "PUT",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories",
+ "url": "/orgs/{org}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Sets the repositories for a required workflow that is required for selected repositories.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-a-required-workflow",
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -8682,8 +6321,8 @@
"deprecated": null
},
{
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -8695,10 +6334,10 @@
"deprecated": null
},
{
- "name": "selected_repository_ids",
- "description": "The IDs of the repositories for which the workflow should be required.",
+ "name": "labels",
+ "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
"in": "BODY",
- "type": "integer[]",
+ "type": "string[]",
"required": true,
"enum": null,
"allowNull": false,
@@ -8708,26 +6347,42 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
"renamed": null
},
{
- "name": "Set selected repositories enabled for GitHub Actions in an organization",
+ "name": "Set custom labels for a self-hosted runner for a repository",
"scope": "actions",
- "id": "setSelectedRepositoriesEnabledGithubActionsOrganization",
+ "id": "setCustomLabelsForSelfHostedRunnerForRepo",
"method": "PUT",
- "url": "/orgs/{org}/actions/permissions/repositories",
+ "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization",
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -8739,39 +6394,8 @@
"deprecated": null
},
{
- "name": "selected_repository_ids",
- "description": "List of repository IDs to enable for GitHub Actions.",
- "in": "BODY",
- "type": "integer[]",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Set the level of access for workflows outside of the repository",
- "scope": "actions",
- "id": "setWorkflowAccessToRepository",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/actions/permissions/access",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)\".\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -8783,10 +6407,10 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -8796,12 +6420,12 @@
"deprecated": null
},
{
- "name": "access_level",
- "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.",
+ "name": "labels",
+ "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
"in": "BODY",
- "type": "string",
+ "type": "string[]",
"required": true,
- "enum": ["none", "user", "organization", "enterprise"],
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8809,28 +6433,44 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
"renamed": null
},
{
- "name": "Update an environment variable",
+ "name": "Set default workflow permissions for an enterprise",
"scope": "actions",
- "id": "updateEnvironmentVariable",
- "method": "PATCH",
- "url": "/repositories/{repository_id}/environments/{environment_name}/variables/{name}",
+ "id": "setGithubActionsDefaultWorkflowPermissionsEnterprise",
+ "method": "PUT",
+ "url": "/enterprises/{enterprise}/actions/permissions/workflow",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-environment-variable",
+ "description": "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](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-an-enterprise",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "repository_id",
- "description": "The unique identifier of the repository.",
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"in": "PATH",
- "type": "integer",
+ "type": "string",
"required": true,
"enum": null,
"allowNull": false,
@@ -8840,12 +6480,12 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "default_workflow_permissions",
+ "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
"in": "BODY",
"type": "string",
"required": false,
- "enum": null,
+ "enum": ["read", "write"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8853,10 +6493,10 @@
"deprecated": null
},
{
- "name": "value",
- "description": "The value of the variable.",
+ "name": "can_approve_pull_request_reviews",
+ "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
"in": "BODY",
- "type": "string",
+ "type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
@@ -8866,20 +6506,22 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ { "code": 204, "description": "Success response", "examples": null }
+ ],
"renamed": null
},
{
- "name": "Update an organization variable",
+ "name": "Set default workflow permissions for an organization",
"scope": "actions",
- "id": "updateOrgVariable",
- "method": "PATCH",
- "url": "/orgs/{org}/actions/variables/{name}",
+ "id": "setGithubActionsDefaultWorkflowPermissionsOrganization",
+ "method": "PUT",
+ "url": "/orgs/{org}/actions/permissions/workflow",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Updates an organization variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\nGitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#update-an-organization-variable",
+ "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions",
"previews": [],
"headers": [],
"parameters": [
@@ -8897,12 +6539,12 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "default_workflow_permissions",
+ "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
"in": "BODY",
"type": "string",
"required": false,
- "enum": null,
+ "enum": ["read", "write"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -8910,10 +6552,10 @@
"deprecated": null
},
{
- "name": "value",
- "description": "The value of the variable.",
+ "name": "can_approve_pull_request_reviews",
+ "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
"in": "BODY",
- "type": "string",
+ "type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
@@ -8921,48 +6563,29 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "visibility",
- "description": "The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["all", "private", "selected"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
+ }
+ ],
+ "responses": [
+ { "code": 204, "description": "Success response", "examples": null },
{
- "name": "selected_repository_ids",
- "description": "An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.",
- "in": "BODY",
- "type": "integer[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
+ "code": 409,
+ "description": "Conflict response when changing a setting is prevented by the owning enterprise",
+ "examples": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
- "name": "Update a repository variable",
+ "name": "Set default workflow permissions for a repository",
"scope": "actions",
- "id": "updateRepoVariable",
- "method": "PATCH",
- "url": "/repos/{owner}/{repo}/actions/variables/{name}",
+ "id": "setGithubActionsDefaultWorkflowPermissionsRepository",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/actions/permissions/workflow",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/actions/variables#update-a-repository-variable",
+ "description": "Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-default-workflow-permissions-for-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -8993,12 +6616,12 @@
"deprecated": null
},
{
- "name": "name",
- "description": "The name of the variable.",
+ "name": "default_workflow_permissions",
+ "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows.",
"in": "BODY",
"type": "string",
"required": false,
- "enum": null,
+ "enum": ["read", "write"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -9006,10 +6629,10 @@
"deprecated": null
},
{
- "name": "value",
- "description": "The value of the variable.",
+ "name": "can_approve_pull_request_reviews",
+ "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.",
"in": "BODY",
- "type": "string",
+ "type": "boolean",
"required": false,
"enum": null,
"allowNull": false,
@@ -9019,20 +6642,27 @@
"deprecated": null
}
],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "responses": [
+ { "code": 204, "description": "Success response", "examples": null },
+ {
+ "code": 409,
+ "description": "Conflict response when changing a setting is prevented by the owning organization or enterprise",
+ "examples": null
+ }
+ ],
"renamed": null
},
{
- "name": "Update a required workflow",
+ "name": "Set GitHub Actions permissions for an organization",
"scope": "actions",
- "id": "updateRequiredWorkflow",
- "method": "PATCH",
- "url": "/orgs/{org}/actions/required_workflows/{required_workflow_id}",
+ "id": "setGithubActionsPermissionsOrganization",
+ "method": "PUT",
+ "url": "/orgs/{org}/actions/permissions",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Update a required workflow in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.\n\nFor more information, see \"[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/actions#update-a-required-workflow",
+ "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -9050,12 +6680,12 @@
"deprecated": null
},
{
- "name": "required_workflow_id",
- "description": "The unique identifier of the required workflow.",
- "in": "PATH",
- "type": "integer",
+ "name": "enabled_repositories",
+ "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.",
+ "in": "BODY",
+ "type": "string",
"required": true,
- "enum": null,
+ "enum": ["all", "none", "selected"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -9063,11 +6693,42 @@
"deprecated": null
},
{
- "name": "workflow_file_path",
- "description": "Path of the workflow file to be configured as a required workflow.",
+ "name": "allowed_actions",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
"in": "BODY",
"type": "string",
"required": false,
+ "enum": ["all", "local_only", "selected"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set GitHub Actions permissions for a repository",
+ "scope": "actions",
+ "id": "setGithubActionsPermissionsRepository",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/actions/permissions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions and reusable workflows, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-a-repository",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -9076,11 +6737,68 @@
"deprecated": null
},
{
- "name": "repository_id",
- "description": "The ID of the repository that contains the workflow file.",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "enabled",
+ "description": "Whether GitHub Actions is enabled on the repository.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "allowed_actions",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
"in": "BODY",
"type": "string",
"required": false,
+ "enum": ["all", "local_only", "selected"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set selected repositories for an organization secret",
+ "scope": "actions",
+ "id": "setSelectedReposForOrgSecret",
+ "method": "PUT",
+ "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -9089,12 +6807,56 @@
"deprecated": null
},
{
- "name": "scope",
- "description": "Enable the required workflow for all repositories or selected repositories in the organization.",
+ "name": "secret_name",
+ "description": "The name of the secret.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "selected_repository_ids",
+ "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
"in": "BODY",
+ "type": "integer[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set selected repositories enabled for GitHub Actions in an organization",
+ "scope": "actions",
+ "id": "setSelectedRepositoriesEnabledGithubActionsOrganization",
+ "method": "PUT",
+ "url": "/orgs/{org}/actions/permissions/repositories",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
"type": "string",
- "required": false,
- "enum": ["selected", "all"],
+ "required": true,
+ "enum": null,
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -9103,10 +6865,10 @@
},
{
"name": "selected_repository_ids",
- "description": "A list of repository IDs where you want to enable the required workflow. A list of repository IDs where you want to enable the required workflow. You can only provide a list of repository ids when the `scope` is set to `selected`.",
+ "description": "List of repository IDs to enable for GitHub Actions.",
"in": "BODY",
"type": "integer[]",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -9115,22 +6877,64 @@
"deprecated": null
}
],
- "responses": [
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set the level of access for workflows outside of the repository",
+ "scope": "actions",
+ "id": "setWorkflowAccessToRepository",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/actions/permissions/access",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-workflow-access-to-a-repository",
+ "previews": [],
+ "headers": [],
+ "parameters": [
{
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"id\":30433642,\"name\":\"Required CI\",\"path\":\".github/workflows/ci.yml\",\"scope\":\"selected\",\"ref\":\"refs/head/main\",\"state\":\"active\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/required_workflows/1/repositories\",\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}}"
- }
- ]
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
},
{
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "access_level",
+ "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": ["none", "organization", "enterprise"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
@@ -9255,7 +7059,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](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).",
+ "description": "The unique identifier of the pull request thread.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -9375,14 +7179,14 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets information about a notification thread.",
+ "description": "",
"documentationUrl": "https://docs.github.com/rest/reference/activity#get-a-thread",
"previews": [],
"headers": [],
"parameters": [
{
"name": "thread_id",
- "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).",
+ "description": "The unique identifier of the pull request thread.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -9430,7 +7234,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](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).",
+ "description": "The unique identifier of the pull request thread.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -10225,7 +8029,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all notifications for the current user in the specified repository.",
+ "description": "List all notifications for the current user.",
"documentationUrl": "https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -10597,7 +8401,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
}
@@ -10739,7 +8543,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
},
@@ -10842,7 +8646,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
"documentationUrl": "https://docs.github.com/rest/reference/activity#mark-notifications-as-read",
"previews": [],
"headers": [],
@@ -10904,7 +8708,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
+ "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.",
"documentationUrl": "https://docs.github.com/rest/reference/activity#mark-repository-notifications-as-read",
"previews": [],
"headers": [],
@@ -10950,15 +8754,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Response",
- "examples": [
- {
- "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}"
- }
- ]
- },
+ { "code": 202, "description": "Response", "examples": null },
{ "code": 205, "description": "Reset Content", "examples": null }
],
"renamed": null
@@ -10972,14 +8768,14 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.",
+ "description": "",
"documentationUrl": "https://docs.github.com/rest/reference/activity#mark-a-thread-as-read",
"previews": [],
"headers": [],
"parameters": [
{
"name": "thread_id",
- "description": "The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).",
+ "description": "The unique identifier of the pull request thread.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -11094,7 +8890,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](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user)).",
+ "description": "The unique identifier of the pull request thread.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -11669,19 +9465,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "permissions.repository_announcement_banners",
- "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["read", "write"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "permissions.repository_hooks",
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
@@ -11827,20 +9610,7 @@
},
{
"name": "permissions.organization_custom_roles",
- "description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["read", "write"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "permissions.organization_announcement_banners",
- "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
+ "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.",
"in": "BODY",
"type": "string",
"required": false,
@@ -12360,7 +10130,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}"
+ "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}"
}
]
},
@@ -12411,7 +10181,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}"
+ "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}"
}
]
},
@@ -12630,7 +10400,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]"
+ "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]"
}
]
},
@@ -12734,7 +10504,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]"
+ "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]"
}
]
},
@@ -13004,7 +10774,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]"
+ "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]"
}
]
},
@@ -13064,7 +10834,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]"
+ "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]"
}
]
},
@@ -13184,7 +10954,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]"
+ "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]"
}
]
},
@@ -13245,7 +11015,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"FLAT_RATE\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]"
+ "data": "[{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"account\":{\"login\":\"github\",\"id\":4,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"type\":\"Organization\"},\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}]"
}
]
},
@@ -13297,19 +11067,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "redelivery",
- "description": "",
- "in": "QUERY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -13361,11 +11118,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{
@@ -13806,19 +11559,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "permissions.repository_announcement_banners",
- "description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["read", "write"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "permissions.repository_hooks",
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
@@ -13964,20 +11704,7 @@
},
{
"name": "permissions.organization_custom_roles",
- "description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["read", "write"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "permissions.organization_announcement_banners",
- "description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
+ "description": "The level of permission to grant the access token for custom roles management. This property is in beta and is subject to change.",
"in": "BODY",
"type": "string",
"required": false,
@@ -14348,6 +12075,150 @@
],
"renamed": null
},
+ {
+ "name": "Get GitHub Advanced Security active committers for an enterprise",
+ "scope": "billing",
+ "id": "getGithubAdvancedSecurityBillingGhe",
+ "method": "GET",
+ "url": "/enterprises/{enterprise}/settings/billing/advanced-security",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets the GitHub Advanced Security active committers for an enterprise per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
+ "documentationUrl": "https://docs.github.com/rest/reference/billing#export-advanced-security-active-committers-data-for-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Success",
+ "examples": [
+ {
+ "data": "{\"total_advanced_security_committers\":2,\"total_count\":2,\"repositories\":[{\"name\":\"octocat-org/Hello-World\",\"advanced_security_committers\":2,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octocat\",\"last_pushed_date\":\"2021-11-03\"},{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-25\"}]},{\"name\":\"octocat-org/server\",\"advanced_security_committers\":1,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-26\"}]}]}"
+ }
+ ]
+ },
+ {
+ "code": 403,
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Get GitHub Advanced Security active committers for an organization",
+ "scope": "billing",
+ "id": "getGithubAdvancedSecurityBillingOrg",
+ "method": "GET",
+ "url": "/orgs/{org}/settings/billing/advanced-security",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets the GitHub Advanced Security active committers for an organization per repository.\n\nEach distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.\n\nIf this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.\n\nThe total number of repositories with committer information is tracked by the `total_count` field.",
+ "documentationUrl": "https://docs.github.com/rest/reference/billing#get-github-advanced-security-active-committers-for-an-organization",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Success",
+ "examples": [
+ {
+ "data": "{\"total_advanced_security_committers\":2,\"total_count\":2,\"repositories\":[{\"name\":\"octocat-org/Hello-World\",\"advanced_security_committers\":2,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octocat\",\"last_pushed_date\":\"2021-11-03\"},{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-25\"}]},{\"name\":\"octocat-org/server\",\"advanced_security_committers\":1,\"advanced_security_committers_breakdown\":[{\"user_login\":\"octokitten\",\"last_pushed_date\":\"2021-10-26\"}]}]}"
+ }
+ ]
+ },
+ {
+ "code": 403,
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
{
"name": "Get GitHub Packages billing for an organization",
"scope": "billing",
@@ -15349,11 +13220,7 @@
}
],
"responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- },
+ { "code": 201, "description": "Response", "examples": null },
{
"code": 403,
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
@@ -15422,13 +13289,7 @@
"deprecated": null
}
],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [{ "data": "null" }]
- }
- ],
+ "responses": [{ "code": 201, "description": "Response", "examples": null }],
"renamed": null
},
{
@@ -15473,7 +13334,7 @@
},
{
"name": "auto_trigger_checks",
- "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.",
+ "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/rest/reference/checks#auto_trigger_checks-object) description for details.",
"in": "BODY",
"type": "object[]",
"required": false,
@@ -15679,7 +13540,7 @@
},
{
"name": "output",
- "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.",
+ "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/rest/reference/checks#output-object-1) description.",
"in": "BODY",
"type": "object",
"required": false,
@@ -15731,7 +13592,7 @@
},
{
"name": "output.annotations",
- "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\".",
+ "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.",
"in": "BODY",
"type": "object[]",
"required": false,
@@ -15757,7 +13618,7 @@
},
{
"name": "output.annotations[].start_line",
- "description": "The start line of the annotation. Line numbers start at 1.",
+ "description": "The start line of the annotation.",
"in": "BODY",
"type": "integer",
"required": true,
@@ -15783,7 +13644,7 @@
},
{
"name": "output.annotations[].start_column",
- "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.",
+ "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.",
"in": "BODY",
"type": "integer",
"required": false,
@@ -15861,7 +13722,7 @@
},
{
"name": "output.images",
- "description": "Adds images to the output displayed in the GitHub pull request UI.",
+ "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/rest/reference/checks#annotations-object-1) description for details.",
"in": "BODY",
"type": "object[]",
"required": false,
@@ -16075,7 +13936,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.",
+ "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.",
"documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert",
"previews": [],
"headers": [],
@@ -16353,10 +14214,88 @@
"deprecated": null
},
{
- "name": "sarif_id",
- "description": "The SARIF ID obtained after uploading.",
+ "name": "sarif_id",
+ "description": "The SARIF ID obtained after uploading.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}"
+ }
+ ]
+ },
+ {
+ "code": 403,
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "examples": null
+ },
+ {
+ "code": 404,
+ "description": "Not Found if the sarif id does not match any upload",
+ "examples": null
+ },
+ { "code": 503, "description": "Service unavailable", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List instances of a code scanning alert",
+ "scope": "codeScanning",
+ "id": "listAlertInstances",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "alert_number",
+ "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.",
"in": "PATH",
- "type": "string",
+ "type": "integer",
"required": true,
"enum": null,
"allowNull": false,
@@ -16364,6 +14303,45 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "ref",
+ "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -16372,7 +14350,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}"
+ "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"open\",\"fixed_at\":null,\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"fixed_at\":\"2020-02-14T12:29:18Z\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]"
}
]
},
@@ -16381,32 +14359,28 @@
"description": "Response if GitHub Advanced Security is not enabled for this repository",
"examples": null
},
- {
- "code": 404,
- "description": "Not Found if the sarif id does not match any upload",
- "examples": null
- },
+ { "code": 404, "description": "Resource not found", "examples": null },
{ "code": 503, "description": "Service unavailable", "examples": null }
],
"renamed": null
},
{
- "name": "List instances of a code scanning alert",
+ "name": "List code scanning alerts for an enterprise",
"scope": "codeScanning",
- "id": "listAlertInstances",
+ "id": "listAlertsForEnterprise",
"method": "GET",
- "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
+ "url": "/enterprises/{enterprise}/code-scanning/alerts",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all instances of the specified code scanning alert.\nYou must use an access token with the `security_events` scope to use this endpoint with private repos,\nthe `public_repo` scope also grants permission to read security events on public repos only.\nGitHub Apps must have the `security_events` read permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert",
+ "description": "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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be a member of the enterprise,\nand you must use an access token with the `repo` scope or `security_events` scope.",
+ "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-enterprise",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
"in": "PATH",
"type": "string",
"required": true,
@@ -16418,11 +14392,11 @@
"deprecated": null
},
{
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
+ "name": "tool_name",
+ "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
+ "in": "QUERY",
"type": "string",
- "required": true,
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -16431,11 +14405,37 @@
"deprecated": null
},
{
- "name": "alert_number",
- "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.",
- "in": "PATH",
- "type": "integer",
- "required": true,
+ "name": "tool_guid",
+ "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "before",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "after",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -16470,12 +14470,38 @@
"deprecated": null
},
{
- "name": "ref",
- "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.",
+ "name": "direction",
+ "description": "The direction to sort the results by.",
"in": "QUERY",
"type": "string",
"required": false,
- "enum": null,
+ "enum": ["asc", "desc"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "state",
+ "description": "If specified, only code scanning alerts with this state will be returned.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": ["open", "closed", "dismissed", "fixed"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "sort",
+ "description": "The property by which to sort the results.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": ["created", "updated"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -16489,7 +14515,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"open\",\"fixed_at\":null,\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"fixed_at\":\"2020-02-14T12:29:18Z\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]"
+ "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"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}\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\"}},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"dismissed_comment\":\"This alert is not actually correct, because there's a sanitizer included in the library.\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"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}\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\"}}]"
}
]
},
@@ -16558,7 +14584,7 @@
},
{
"name": "before",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -16571,7 +14597,7 @@
},
{
"name": "after",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -16646,27 +14672,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "severity",
- "description": "If specified, only code scanning alerts with this severity will be returned.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": [
- "critical",
- "high",
- "medium",
- "low",
- "warning",
- "note",
- "error"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -16679,6 +14684,11 @@
}
]
},
+ {
+ "code": 403,
+ "description": "Response if GitHub Advanced Security is not enabled for this repository",
+ "examples": null
+ },
{ "code": 404, "description": "Resource not found", "examples": null },
{ "code": 503, "description": "Service unavailable", "examples": null }
],
@@ -17316,7 +15326,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration (For example, for the CodeQL tool, identify and remove the most noisy queries).\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 15 | |\n| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |\n| Rules per run | 25,000 | |\n| Tool extensions per run | 100 | |\n| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |\n| Location per result\t | 1,000 | Only 100 locations will be included. |\n| Tags per rule\t | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
+ "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
"documentationUrl": "https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file",
"previews": [],
"headers": [],
@@ -17424,19 +15434,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "validate",
- "description": "Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -17603,7 +15600,7 @@
"scope": "codespaces",
"id": "addSelectedRepoToOrgSecret",
"method": "PUT",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -17944,8 +15941,7 @@
"examples": null
},
{ "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- { "code": 503, "description": "Service unavailable", "examples": null }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
@@ -17954,11 +15950,11 @@
"scope": "codespaces",
"id": "createOrUpdateOrgSecret",
"method": "PUT",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\n// Written with ❤️ by PSJ and free to use under The Unlicense.\nconst sodium=require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with secret before running the script.\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key.\n\n//Check if libsodium is ready and then proceed.\n\nsodium.ready.then( ()=>{\n\n// Convert Secret & Base64 key to Uint8Array.\nlet binkey= sodium.from_base64(key, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(key, 'base64')\nlet binsec= sodium.from_string(secret) // Equivalent of Buffer.from(secret)\n\n//Encrypt the secret using LibSodium\nlet encBytes= sodium.crypto_box_seal(binsec,binkey) // Similar to tweetsodium.seal(binsec,binkey)\n\n// Convert encrypted Uint8Array to Base64\nlet output=sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(encBytes).toString('base64')\n\nconsole.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-an-organization-secret",
"previews": [],
"headers": [],
@@ -18071,7 +16067,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`\nrepository permission to use this endpoint.\n\n#### Example of encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example of encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example of encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example of encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository\npermission to use this endpoint.\n\n#### Example of encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example of encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example of encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example of encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-a-repository-secret",
"previews": [],
"headers": [],
@@ -18146,7 +16142,7 @@
{
"code": 201,
"description": "Response when creating a secret",
- "examples": [{ "data": "null" }]
+ "examples": null
},
{
"code": 204,
@@ -18165,7 +16161,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages).\n\nYou must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#create-or-update-a-secret-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -18226,8 +16222,8 @@
"responses": [
{
"code": 201,
- "description": "Response after successfully creating a secret",
- "examples": [{ "data": "null" }]
+ "description": "Response after successfully creaing a secret",
+ "examples": null
},
{
"code": 204,
@@ -18439,8 +16435,7 @@
"examples": null
},
{ "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- { "code": 503, "description": "Service unavailable", "examples": null }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
@@ -18642,8 +16637,7 @@
"examples": null
},
{ "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- { "code": 503, "description": "Service unavailable", "examples": null }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
@@ -18676,11 +16670,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{ "code": 304, "description": "Not modified", "examples": null },
{
"code": 401,
@@ -18748,11 +16738,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{ "code": 304, "description": "Not modified", "examples": null },
{
"code": 401,
@@ -18770,7 +16756,7 @@
"scope": "codespaces",
"id": "deleteOrgSecret",
"method": "DELETE",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -18821,7 +16807,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.",
+ "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#delete-a-repository-secret",
"previews": [],
"headers": [],
@@ -18909,8 +16895,8 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nIf changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user",
+ "description": "Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.",
+ "documentationUrl": "",
"previews": [],
"headers": [],
"parameters": [
@@ -18954,95 +16940,6 @@
],
"renamed": null
},
- {
- "name": "List codespaces for a user in organization",
- "scope": "codespaces",
- "id": "getCodespacesForUserInOrg",
- "method": "GET",
- "url": "/orgs/{org}/members/{username}/codespaces",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Lists the codespaces that a member of an organization has for repositories in that organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-codespaces-for-user-in-org",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "username",
- "description": "The handle for the GitHub user account.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"total_count\":3,\"codespaces\":[{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-3f89ada1j3\",\"environment_id\":\"526ce4d7-46da-494f-a4f9-cfd25b818719\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/foobar/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-3f89ada1j3.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop\",\"recent_folders\":[]},{\"id\":1,\"name\":\"monalisa-octocat-hello-world-f8adfad99a\",\"environment_id\":\"6ac8cd6d-a2d0-4ae3-8cea-e135059264df\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"web_url\":\"https://monalisa-octocat-hello-world-f8adfad99a.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop\",\"recent_folders\":[]}]}"
- }
- ]
- },
- { "code": 304, "description": "Not modified", "examples": null },
- {
- "code": 401,
- "description": "Requires authentication",
- "examples": null
- },
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- { "code": 500, "description": "Internal Error", "examples": null }
- ],
- "renamed": null
- },
{
"name": "Get details about a codespace export",
"scope": "codespaces",
@@ -19053,7 +16950,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Gets information about an export of a codespace.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export",
+ "documentationUrl": "",
"previews": [],
"headers": [],
"parameters": [
@@ -19153,7 +17050,7 @@
"scope": "codespaces",
"id": "getOrgPublicKey",
"method": "GET",
- "url": "/orgs/{org}/codespaces/secrets/public-key",
+ "url": "/organizations/{org}/codespaces/secrets/public-key",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -19194,7 +17091,7 @@
"scope": "codespaces",
"id": "getOrgSecret",
"method": "GET",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -19279,7 +17176,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-public-key",
"previews": [],
"headers": [],
@@ -19333,7 +17230,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.",
+ "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#get-a-repository-secret",
"previews": [],
"headers": [],
@@ -19780,7 +17677,7 @@
"scope": "codespaces",
"id": "listOrgSecrets",
"method": "GET",
- "url": "/orgs/{org}/codespaces/secrets",
+ "url": "/organizations/{org}/codespaces/secrets",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -19851,7 +17748,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.",
+ "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/codespaces#list-repository-secrets",
"previews": [],
"headers": [],
@@ -20030,7 +17927,7 @@
"scope": "codespaces",
"id": "listSelectedReposForOrgSecret",
"method": "GET",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -20193,85 +18090,6 @@
],
"renamed": null
},
- {
- "name": "Create a repository from an unpublished codespace",
- "scope": "codespaces",
- "id": "publishForAuthenticatedUser",
- "method": "POST",
- "url": "/user/codespaces/{codespace_name}/publish",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.\n\nThe codespace's token is granted write permissions to the repository, allowing the user to push their changes.\n\nThis will fail for a codespace that is already published, meaning it has an associated repository.\n\nYou must authenticate using a personal access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "codespace_name",
- "description": "The name of the codespace.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "name",
- "description": "A name for the new repository.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "private",
- "description": "Whether the new repository should be private.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [
- {
- "data": "{\"id\":1,\"name\":\"monalisa-octocat-hello-world-g4wpq6h95q\",\"environment_id\":\"26a7c758-7299-4a73-b978-5a92a7ae98a0\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"billable_owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"machine\":{\"name\":\"standardLinux\",\"display_name\":\"4 cores, 8 GB RAM, 64 GB storage\",\"operating_system\":\"linux\",\"storage_in_bytes\":68719476736,\"memory_in_bytes\":8589934592,\"cpus\":4},\"prebuild\":false,\"devcontainer_path\":\".devcontainer/devcontainer.json\",\"created_at\":\"2021-10-14T00:53:30-06:00\",\"updated_at\":\"2021-10-14T00:53:32-06:00\",\"last_used_at\":\"2021-10-14T00:53:30-06:00\",\"state\":\"Available\",\"url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q\",\"git_status\":{\"ahead\":0,\"behind\":0,\"has_unpushed_changes\":false,\"has_uncommitted_changes\":false,\"ref\":\"main\"},\"location\":\"WestUs2\",\"idle_timeout_minutes\":60,\"retention_period_minutes\":43200,\"retention_expires_at\":null,\"web_url\":\"https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev\",\"machines_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines\",\"start_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start\",\"stop_url\":\"https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"recent_folders\":[],\"template\":null}"
- }
- ]
- },
- {
- "code": 401,
- "description": "Requires authentication",
- "examples": null
- },
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- }
- ],
- "renamed": null
- },
{
"name": "Remove a selected repository from a user secret",
"scope": "codespaces",
@@ -20335,7 +18153,7 @@
"scope": "codespaces",
"id": "removeSelectedRepoFromOrgSecret",
"method": "DELETE",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -20493,87 +18311,6 @@
],
"renamed": null
},
- {
- "name": "Manage access control for organization codespaces",
- "scope": "codespaces",
- "id": "setCodespacesBilling",
- "method": "PUT",
- "url": "/orgs/{org}/codespaces/billing",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/codespaces#set-codespaces-billing",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "visibility",
- "description": "Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": [
- "disabled",
- "selected_members",
- "all_members",
- "all_members_and_outside_collaborators"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "selected_usernames",
- "description": "The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.",
- "in": "BODY",
- "type": "string[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 204,
- "description": "Response when successfully modifying permissions.",
- "examples": null
- },
- { "code": 304, "description": "Not modified", "examples": null },
- {
- "code": 400,
- "description": "Users are neither members nor collaborators of this organization.",
- "examples": null
- },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- },
- { "code": 500, "description": "Internal Error", "examples": null }
- ],
- "renamed": null
- },
{
"name": "Set selected repositories for a user secret",
"scope": "codespaces",
@@ -20637,7 +18374,7 @@
"scope": "codespaces",
"id": "setSelectedReposForOrgSecret",
"method": "PUT",
- "url": "/orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "url": "/organizations/{org}/codespaces/secrets/{secret_name}/repositories",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
@@ -21147,7 +18884,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
+ "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```",
"documentationUrl": "https://docs.github.com/rest/reference/dependabot#create-or-update-a-repository-secret",
"previews": [],
"headers": [],
@@ -21375,7 +19112,7 @@
},
{
"name": "alert_number",
- "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.",
+ "description": "The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -21393,7 +19130,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"severity\":\"medium\",\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null}"
+ "data": "{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"severity\":\"medium\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}]},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null}"
}
]
},
@@ -21491,128 +19228,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"name\":\"NPM_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories\"}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "Get a repository public key",
- "scope": "dependabot",
- "id": "getRepoPublicKey",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/dependabot/secrets/public-key",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "Get a repository secret",
- "scope": "dependabot",
- "id": "getRepoSecret",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-secret",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_name",
- "description": "The name of the secret.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"name\":\"MY_ARTIFACTORY_PASSWORD\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}"
+ "data": "{\"name\":\"NPM_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/dependabot/secrets/NPM_TOKEN/repositories\"}"
}
]
}
@@ -21620,22 +19236,22 @@
"renamed": null
},
{
- "name": "List Dependabot alerts for an enterprise",
+ "name": "Get a repository public key",
"scope": "dependabot",
- "id": "listAlertsForEnterprise",
+ "id": "getRepoPublicKey",
"method": "GET",
- "url": "/enterprises/{enterprise}/dependabot/alerts",
+ "url": "/repos/{owner}/{repo}/dependabot/secrets/public-key",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
- "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise",
+ "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-public-key",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "enterprise",
- "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -21647,154 +19263,11 @@
"deprecated": null
},
{
- "name": "state",
- "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `dismissed`, `fixed`, `open`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "severity",
- "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "ecosystem",
- "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "package",
- "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "scope",
- "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["development", "runtime"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "sort",
- "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["created", "updated"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["asc", "desc"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "before",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "after",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
- "in": "QUERY",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
"type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "first",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "last",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -21809,38 +19282,30 @@
"description": "Response",
"examples": [
{
- "data": "[{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"severity\":\"high\",\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2\",\"html_url\":\"https://github.com/octo-org/octo-repo/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null,\"repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"owner\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":true,\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\"}},{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"severity\":\"medium\",\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octo-org/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null,\"repository\":{\"id\":664700648,\"node_id\":\"MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=\",\"name\":\"hello-world\",\"full_name\":\"octo-org/hello-world\",\"owner\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":true,\"html_url\":\"https://github.com/octo-org/hello-world\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/hello-world\",\"archive_url\":\"https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/hello-world/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/hello-world/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/hello-world/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/hello-world/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/hello-world/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/hello-world/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/hello-world/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/hello-world/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/hello-world/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/hello-world/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octo-org/hello-world/hooks\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/hello-world/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/hello-world/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/hello-world/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/hello-world/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/hello-world/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/hello-world/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/hello-world/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/hello-world/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/hello-world/releases{/id}\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/hello-world/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/hello-world/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/hello-world/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/hello-world/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/hello-world/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/hello-world/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}\"}}]"
+ "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}"
}
]
- },
- { "code": 304, "description": "Not modified", "examples": null },
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
}
],
"renamed": null
},
{
- "name": "List Dependabot alerts for an organization",
+ "name": "Get a repository secret",
"scope": "dependabot",
- "id": "listAlertsForOrg",
+ "id": "getRepoSecret",
"method": "GET",
- "url": "/orgs/{org}/dependabot/alerts",
+ "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists Dependabot alerts for an organization.\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have **Dependabot alerts** read permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization",
+ "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/dependabot#get-a-repository-secret",
"previews": [],
"headers": [],
"parameters": [
{
- "name": "org",
- "description": "The organization name. The name is not case sensitive.",
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
"in": "PATH",
"type": "string",
"required": true,
@@ -21852,102 +19317,11 @@
"deprecated": null
},
{
- "name": "state",
- "description": "A comma-separated list of states. If specified, only alerts with these states will be returned.\n\nCan be: `dismissed`, `fixed`, `open`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "severity",
- "description": "A comma-separated list of severities. If specified, only alerts with these severities will be returned.\n\nCan be: `low`, `medium`, `high`, `critical`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "ecosystem",
- "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "package",
- "description": "A comma-separated list of package names. If specified, only alerts for these packages will be returned.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "scope",
- "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["development", "runtime"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "sort",
- "description": "The property by which to sort the results.\n`created` means when the alert was created.\n`updated` means when the alert's state last changed.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["created", "updated"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "direction",
- "description": "The direction to sort the results by.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": ["asc", "desc"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "before",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
- "in": "QUERY",
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
"type": "string",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -21956,50 +19330,11 @@
"deprecated": null
},
{
- "name": "after",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
- "in": "QUERY",
+ "name": "secret_name",
+ "description": "The name of the secret.",
+ "in": "PATH",
"type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "first",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "last",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -22014,19 +19349,9 @@
"description": "Response",
"examples": [
{
- "data": "[{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"severity\":\"high\",\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octo-org/octo-repo/dependabot/alerts/2\",\"html_url\":\"https://github.com/octo-org/octo-repo/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null,\"repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"owner\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":true,\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\"}},{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"severity\":\"medium\",\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octo-org/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octo-org/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null,\"repository\":{\"id\":664700648,\"node_id\":\"MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg=\",\"name\":\"hello-world\",\"full_name\":\"octo-org/hello-world\",\"owner\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":true,\"html_url\":\"https://github.com/octo-org/hello-world\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/hello-world\",\"archive_url\":\"https://api.github.com/repos/octo-org/hello-world/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octo-org/hello-world/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octo-org/hello-world/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octo-org/hello-world/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/hello-world/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octo-org/hello-world/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octo-org/hello-world/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octo-org/hello-world/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octo-org/hello-world/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octo-org/hello-world/contributors\",\"deployments_url\":\"https://api.github.com/repos/octo-org/hello-world/deployments\",\"downloads_url\":\"https://api.github.com/repos/octo-org/hello-world/downloads\",\"events_url\":\"https://api.github.com/repos/octo-org/hello-world/events\",\"forks_url\":\"https://api.github.com/repos/octo-org/hello-world/forks\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/hello-world/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/hello-world/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/hello-world/git/tags{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octo-org/hello-world/hooks\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/hello-world/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/hello-world/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octo-org/hello-world/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octo-org/hello-world/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octo-org/hello-world/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octo-org/hello-world/languages\",\"merges_url\":\"https://api.github.com/repos/octo-org/hello-world/merges\",\"milestones_url\":\"https://api.github.com/repos/octo-org/hello-world/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/hello-world/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/hello-world/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octo-org/hello-world/releases{/id}\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/hello-world/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octo-org/hello-world/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/hello-world/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/hello-world/subscription\",\"tags_url\":\"https://api.github.com/repos/octo-org/hello-world/tags\",\"teams_url\":\"https://api.github.com/repos/octo-org/hello-world/teams\",\"trees_url\":\"https://api.github.com/repos/octo-org/hello-world/git/trees{/sha}\"}}]"
+ "data": "{\"name\":\"MY_ARTIFACTORY_PASSWORD\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}"
}
]
- },
- { "code": 304, "description": "Not modified", "examples": null },
- { "code": 400, "description": "Bad Request", "examples": null },
- { "code": 400, "description": "Bad Request", "examples": null },
- { "code": 403, "description": "Forbidden", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
}
],
"renamed": null
@@ -22099,7 +19424,7 @@
},
{
"name": "ecosystem",
- "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
+ "description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`",
"in": "QUERY",
"type": "string",
"required": false,
@@ -22138,7 +19463,7 @@
},
{
"name": "scope",
- "description": "The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned.",
+ "description": "Scope of the dependency on a Dependabot alert.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -22177,7 +19502,7 @@
},
{
"name": "page",
- "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
+ "description": "Page number of the results to fetch.",
"in": "QUERY",
"type": "integer",
"required": false,
@@ -22200,58 +19525,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "before",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "after",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
- "in": "QUERY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "first",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.\nInstead, use `per_page` in combination with `after` to fetch the first page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "last",
- "description": "**Deprecated**. The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.\nInstead, use `per_page` in combination with `before` to fetch the last page of results.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -22260,13 +19533,11 @@
"description": "Response",
"examples": [
{
- "data": "[{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"severity\":\"high\",\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null},{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"severity\":\"medium\",\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null}]"
+ "data": "[{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"severity\":\"high\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}]},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null},{\"number\":1,\"state\":\"open\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-8f4m-hccc-8qph\",\"cve_id\":\"CVE-2021-20191\",\"summary\":\"Insertion of Sensitive Information into Log File in ansible\",\"description\":\"A flaw was found in ansible. Credentials, such as secrets, are being disclosed in console log by default and not protected by no_log feature when using those modules. An attacker can take advantage of this information to steal those credentials. The highest threat from this vulnerability is to data confidentiality.\",\"severity\":\"medium\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-8f4m-hccc-8qph\"},{\"type\":\"CVE\",\"value\":\"CVE-2021-20191\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2021-20191\"},{\"url\":\"https://access.redhat.com/security/cve/cve-2021-20191\"},{\"url\":\"https://bugzilla.redhat.com/show_bug.cgi?id=1916813\"}],\"published_at\":\"2021-06-01T17:38:00Z\",\"updated_at\":\"2021-08-12T23:06:00Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.9.0, < 2.9.18\",\"first_patched_version\":{\"identifier\":\"2.9.18\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\">= 2.10.0, < 2.10.7\",\"first_patched_version\":{\"identifier\":\"2.10.7\"}}],\"cvss\":{\"vector_string\":\"CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N\",\"score\":5.5},\"cwes\":[{\"cwe_id\":\"CWE-532\",\"name\":\"Insertion of Sensitive Information into Log File\"}]},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"ansible\"},\"severity\":\"medium\",\"vulnerable_version_range\":\"< 2.8.19\",\"first_patched_version\":{\"identifier\":\"2.8.19\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/1\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/1\",\"created_at\":\"2022-06-14T15:21:52Z\",\"updated_at\":\"2022-06-14T15:21:52Z\",\"dismissed_at\":null,\"dismissed_by\":null,\"dismissed_reason\":null,\"dismissed_comment\":null,\"fixed_at\":null}]"
}
]
},
{ "code": 304, "description": "Not modified", "examples": null },
- { "code": 400, "description": "Bad Request", "examples": null },
- { "code": 400, "description": "Bad Request", "examples": null },
{ "code": 403, "description": "Forbidden", "examples": null },
{ "code": 404, "description": "Resource not found", "examples": null },
{
@@ -22671,7 +19942,7 @@
},
{
"name": "alert_number",
- "description": "The number that identifies a Dependabot alert in its repository.\nYou can find this at the end of the URL for a Dependabot alert within GitHub,\nor in `number` fields in the response from the\n`GET /repos/{owner}/{repo}/dependabot/alerts` operation.",
+ "description": "The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation.",
"in": "PATH",
"type": "integer",
"required": true,
@@ -22684,7 +19955,7 @@
},
{
"name": "state",
- "description": "The state of the Dependabot alert.\nA `dismissed_reason` must be provided when setting the state to `dismissed`.",
+ "description": "Sets the status of the dependabot alert. You must provide `dismissed_reason` when you set the state to `dismissed`.",
"in": "BODY",
"type": "string",
"required": true,
@@ -22697,7 +19968,7 @@
},
{
"name": "dismissed_reason",
- "description": "**Required when `state` is `dismissed`.** A reason for dismissing the alert.",
+ "description": "**Required when the `state` is `dismissed`.** The reason for dismissing the Dependabot alert.",
"in": "BODY",
"type": "string",
"required": false,
@@ -22708,7 +19979,7 @@
"not_used",
"tolerable_risk"
],
- "allowNull": false,
+ "allowNull": true,
"mapToData": null,
"validation": null,
"alias": null,
@@ -22716,12 +19987,12 @@
},
{
"name": "dismissed_comment",
- "description": "An optional comment associated with dismissing the alert.",
+ "description": "An optional comment associated with the alert's dismissal. The maximum size is 280 characters.",
"in": "BODY",
"type": "string",
"required": false,
"enum": null,
- "allowNull": false,
+ "allowNull": true,
"mapToData": null,
"validation": null,
"alias": null,
@@ -22734,10 +20005,11 @@
"description": "Response",
"examples": [
{
- "data": "{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"severity\":\"high\",\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}],\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null}"
+ "data": "{\"number\":2,\"state\":\"dismissed\",\"dependency\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"manifest_path\":\"path/to/requirements.txt\",\"scope\":\"runtime\"},\"security_advisory\":{\"ghsa_id\":\"GHSA-rf4j-j272-fj86\",\"cve_id\":\"CVE-2018-6188\",\"summary\":\"Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive\",\"description\":\"django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.\",\"severity\":\"high\",\"identifiers\":[{\"type\":\"GHSA\",\"value\":\"GHSA-rf4j-j272-fj86\"},{\"type\":\"CVE\",\"value\":\"CVE-2018-6188\"}],\"references\":[{\"url\":\"https://nvd.nist.gov/vuln/detail/CVE-2018-6188\"},{\"url\":\"https://github.com/advisories/GHSA-rf4j-j272-fj86\"},{\"url\":\"https://usn.ubuntu.com/3559-1/\"},{\"url\":\"https://www.djangoproject.com/weblog/2018/feb/01/security-releases/\"},{\"url\":\"http://www.securitytracker.com/id/1040422\"}],\"published_at\":\"2018-10-03T21:13:54Z\",\"updated_at\":\"2022-04-26T18:35:37Z\",\"withdrawn_at\":null,\"vulnerabilities\":[{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 1.11.8, < 1.11.10\",\"first_patched_version\":{\"identifier\":\"1.11.10\"}}],\"cvss\":{\"vector_string\":\"CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N\",\"score\":7.5},\"cwes\":[{\"cwe_id\":\"CWE-200\",\"name\":\"Exposure of Sensitive Information to an Unauthorized Actor\"}]},\"security_vulnerability\":{\"package\":{\"ecosystem\":\"pip\",\"name\":\"django\"},\"severity\":\"high\",\"vulnerable_version_range\":\">= 2.0.0, < 2.0.2\",\"first_patched_version\":{\"identifier\":\"2.0.2\"}},\"url\":\"https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2\",\"html_url\":\"https://github.com/octocat/hello-world/security/dependabot/2\",\"created_at\":\"2022-06-15T07:43:03Z\",\"updated_at\":\"2022-08-23T14:29:47Z\",\"dismissed_at\":\"2022-08-23T14:29:47Z\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_reason\":\"tolerable_risk\",\"dismissed_comment\":\"This alert is accurate but we use a sanitizer.\",\"fixed_at\":null}"
}
]
},
+ { "code": 304, "description": "Not modified", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{ "code": 403, "description": "Forbidden", "examples": null },
@@ -22858,7 +20130,7 @@
},
{
"name": "sha",
- "description": "The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.",
+ "description": "The commit SHA associated with this dependency snapshot.",
"in": "BODY",
"type": "string",
"required": true,
@@ -23365,6 +20637,50 @@
],
"renamed": null
},
+ {
+ "name": "Disable a selected organization for GitHub Actions in an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "disableSelectedOrganizationGithubActionsEnterprise",
+ "method": "DELETE",
+ "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "org_id",
+ "description": "The unique identifier of the organization.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
{
"name": "Enable a selected organization for GitHub Actions in an enterprise",
"scope": "enterpriseAdmin",
@@ -23409,6 +20725,155 @@
"responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
+ {
+ "name": "Get allowed actions and reusable workflows for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "getAllowedActionsEnterprise",
+ "method": "GET",
+ "url": "/enterprises/{enterprise}/actions/permissions/selected-actions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-allowed-actions-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Get GitHub Actions permissions for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "getGithubActionsPermissionsEnterprise",
+ "method": "GET",
+ "url": "/enterprises/{enterprise}/actions/permissions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#get-github-actions-permissions-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"enabled_organizations\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Get GitHub Enterprise Server statistics",
+ "scope": "enterpriseAdmin",
+ "id": "getServerStatistics",
+ "method": "GET",
+ "url": "/enterprise-installation/{enterprise_or_org}/server-statistics",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.\n\nTo use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see \"[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)\" in the GitHub Enterprise Server documentation.\n\nYou'll need to use a personal access token:\n - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.\n - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.\n\nFor more information on creating a personal access token, see \"[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/enterprise-admin#get-github-enterprise-server-statistics",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise_or_org",
+ "description": "The slug version of the enterprise name or the login of an organization.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "date_start",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "date_end",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.",
+ "in": "QUERY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"server_id\":\"ea6088f3-f095-4bf2-8d7f-c573819e8768\",\"collection_date\":\"2021-12-14T23:59:59Z\",\"schema_version\":\"20220111\",\"ghes_version\":\"3.5.0\",\"host_name\":\"github.example.com\",\"github_connect\":{\"features_enabled\":[\"license_usage_sync\",\"content_analysis\",\"content_analysis_notifications\"]},\"ghe_stats\":{\"comments\":{\"total_commit_comments\":1000,\"total_gist_comments\":1000,\"total_issue_comments\":0,\"total_pull_request_comments\":0},\"gists\":{\"total_gists\":100,\"private_gists\":59,\"public_gists\":41},\"hooks\":{\"total_hooks\":2,\"active_hooks\":1,\"inactive_hooks\":1},\"issues\":{\"total_issues\":3421,\"open_issues\":1234,\"closed_issues\":1222},\"milestones\":{\"total_milestones\":50,\"open_milestones\":20,\"closed_milestones\":30},\"orgs\":{\"total_orgs\":100,\"disabled_orgs\":22,\"total_teams\":299,\"total_team_members\":400},\"pages\":{\"total_pages\":10},\"pulls\":{\"total_pulls\":1232,\"merged_pulls\":223,\"mergeable_pulls\":435,\"unmergeable_pulls\":0},\"repos\":{\"total_repos\":12,\"root_repos\":1,\"fork_repos\":2,\"org_repos\":1,\"total_pushes\":42,\"total_wikis\":1},\"users\":{\"total_users\":2000,\"admin_users\":299,\"suspended_users\":423}},\"dormant_users\":{\"total_dormant_users\":5,\"dormancy_threshold\":\"90 days\"}}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
{
"name": "List labels for a self-hosted runner for an enterprise",
"scope": "enterpriseAdmin",
@@ -23460,10 +20925,454 @@
}
]
},
- { "code": 404, "description": "Resource not found", "examples": null }
+ { "code": 404, "description": "Resource not found", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List selected organizations enabled for GitHub Actions in an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "listSelectedOrganizationsEnabledGithubActionsEnterprise",
+ "method": "GET",
+ "url": "/enterprises/{enterprise}/actions/permissions/organizations",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "per_page",
+ "description": "The number of results per page (max 100).",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "page",
+ "description": "Page number of the results to fetch.",
+ "in": "QUERY",
+ "type": "integer",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":1,\"organizations\":[{\"login\":\"octocat\",\"id\":161335,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"url\":\"https://api.github.com/orgs/octo-org\",\"repos_url\":\"https://api.github.com/orgs/octo-org/repos\",\"events_url\":\"https://api.github.com/orgs/octo-org/events\",\"hooks_url\":\"https://api.github.com/orgs/octo-org/hooks\",\"issues_url\":\"https://api.github.com/orgs/octo-org/issues\",\"members_url\":\"https://api.github.com/orgs/octo-org/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/octo-org/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]}"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Remove all custom labels from a self-hosted runner for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "removeAllCustomLabelsFromSelfHostedRunnerForEnterprise",
+ "method": "DELETE",
+ "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Remove all custom labels from a self-hosted runner configured in an\nenterprise. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":3,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Remove a custom label from a self-hosted runner for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "removeCustomLabelFromSelfHostedRunnerForEnterprise",
+ "method": "DELETE",
+ "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Remove a custom label from a self-hosted runner configured\nin an enterprise. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "name",
+ "description": "The name of a self-hosted runner's custom label.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
],
"renamed": null
},
+ {
+ "name": "Set allowed actions and reusable workflows for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "setAllowedActionsEnterprise",
+ "method": "PUT",
+ "url": "/enterprises/{enterprise}/actions/permissions/selected-actions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-allowed-actions-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "github_owned_allowed",
+ "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "verified_allowed",
+ "description": "Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "patterns_allowed",
+ "description": "Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
+ "in": "BODY",
+ "type": "string[]",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set custom labels for a self-hosted runner for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "setCustomLabelsForSelfHostedRunnerForEnterprise",
+ "method": "PUT",
+ "url": "/enterprises/{enterprise}/actions/runners/{runner_id}/labels",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "runner_id",
+ "description": "Unique identifier of the self-hosted runner.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "labels",
+ "description": "The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels.",
+ "in": "BODY",
+ "type": "string[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"total_count\":4,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Set GitHub Actions permissions for an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "setGithubActionsPermissionsEnterprise",
+ "method": "PUT",
+ "url": "/enterprises/{enterprise}/actions/permissions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-github-actions-permissions-for-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "enabled_organizations",
+ "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": ["all", "none", "selected"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "allowed_actions",
+ "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": ["all", "local_only", "selected"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Set selected organizations enabled for GitHub Actions in an enterprise",
+ "scope": "enterpriseAdmin",
+ "id": "setSelectedOrganizationsEnabledGithubActionsEnterprise",
+ "method": "PUT",
+ "url": "/enterprises/{enterprise}/actions/permissions/organizations",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "selected_organization_ids",
+ "description": "List of organization IDs to enable for GitHub Actions.",
+ "in": "BODY",
+ "type": "integer[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
{
"name": "Check if a gist is starred",
"scope": "gists",
@@ -23594,7 +21503,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
+ "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}"
}
]
},
@@ -23834,7 +21743,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
+ "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}"
}
]
},
@@ -23948,7 +21857,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
+ "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}"
}
]
},
@@ -24555,7 +22464,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
+ "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
"documentationUrl": "https://docs.github.com/rest/reference/gists/#update-a-gist",
"previews": [],
"headers": [],
@@ -24575,7 +22484,7 @@
},
{
"name": "description",
- "description": "The description of the gist.",
+ "description": "Description of the gist",
"in": "BODY",
"type": "string",
"required": false,
@@ -24588,7 +22497,7 @@
},
{
"name": "files",
- "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`.",
+ "description": "Names of files to be updated",
"in": "BODY",
"type": "object",
"required": false,
@@ -24614,7 +22523,7 @@
},
{
"name": "files.*.content",
- "description": "The new content of the file.",
+ "description": "The new content of the file",
"in": "BODY",
"type": "string",
"required": false,
@@ -24627,7 +22536,7 @@
},
{
"name": "files.*.filename",
- "description": "The new filename for the file.",
+ "description": "The new filename for the file",
"in": "BODY",
"type": "string",
"required": false,
@@ -24645,13 +22554,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
- },
- {
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":null,\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"9cc352a89178a6d4\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":1,\"additions\":0,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
- },
- {
- "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"goodbye.py\":{\"filename\":\"goodbye.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py\",\"size\":4,\"truncated\":false,\"content\":\"# Hello world\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":0,\"additions\":0,\"deletions\":0},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}"
+ "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}"
}
]
},
@@ -26592,356 +24495,31 @@
"deprecated": null
},
{
- "name": "limit",
- "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": ["existing_users", "contributors_only", "collaborators_only"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "expiry",
- "description": "The duration of the interaction restriction. Default: `one_day`.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": [
- "one_day",
- "three_days",
- "one_week",
- "one_month",
- "six_months"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}"
- }
- ]
- },
- { "code": 409, "description": "Response", "examples": null }
- ],
- "renamed": null
- },
- {
- "name": "Set interaction restrictions for your public repositories",
- "scope": "interactions",
- "id": "setRestrictionsForYourPublicRepos",
- "method": "PUT",
- "url": "/user/interaction-limits",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.",
- "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "limit",
- "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": ["existing_users", "contributors_only", "collaborators_only"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "expiry",
- "description": "The duration of the interaction restriction. Default: `one_day`.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": [
- "one_day",
- "three_days",
- "one_week",
- "one_month",
- "six_months"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"limit\":\"collaborators_only\",\"origin\":\"user\",\"expires_at\":\"2018-08-17T04:18:39Z\"}"
- }
- ]
- },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- }
- ],
- "renamed": {
- "before": {
- "scope": "interactions",
- "id": "setRestrictionsForYourPublicRepos"
- },
- "after": {
- "scope": "interactions",
- "id": "setRestrictionsForAuthenticatedUser"
- },
- "date": "2021-02-02",
- "note": null
- }
- },
- {
- "name": "Add assignees to an issue",
- "scope": "issues",
- "id": "addAssignees",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
- "documentationUrl": "https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "issue_number",
- "description": "The number that identifies the issue.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "assignees",
- "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._",
- "in": "BODY",
- "type": "string[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 201,
- "description": "Response",
- "examples": [
- {
- "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}"
- }
- ]
- }
- ],
- "renamed": null
- },
- {
- "name": "Add labels to an issue",
- "scope": "issues",
- "id": "addLabels",
- "method": "POST",
- "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "",
- "documentationUrl": "https://docs.github.com/rest/reference/issues#add-labels-to-an-issue",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "issue_number",
- "description": "The number that identifies the issue.",
- "in": "PATH",
- "type": "integer",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "labels",
- "description": "",
- "in": "BODY",
- "type": "object[]",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "labels[].name",
- "description": "",
- "in": "BODY",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
- }
- ]
- },
- { "code": 301, "description": "Moved permanently", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- { "code": 410, "description": "Gone", "examples": null },
- {
- "code": 422,
- "description": "Validation failed, or the endpoint has been spammed.",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Check if a user can be assigned",
- "scope": "issues",
- "id": "checkUserCanBeAssigned",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/assignees/{assignee}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
- "documentationUrl": "https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "assignee",
- "description": "",
- "in": "PATH",
+ "name": "limit",
+ "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.",
+ "in": "BODY",
"type": "string",
"required": true,
- "enum": null,
+ "enum": ["existing_users", "contributors_only", "collaborators_only"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "expiry",
+ "description": "The duration of the interaction restriction. Default: `one_day`.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": [
+ "one_day",
+ "three_days",
+ "one_week",
+ "one_month",
+ "six_months"
+ ],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -26951,29 +24529,185 @@
],
"responses": [
{
- "code": 204,
- "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.",
- "examples": null
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}"
+ }
+ ]
},
+ { "code": 409, "description": "Response", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Set interaction restrictions for your public repositories",
+ "scope": "interactions",
+ "id": "setRestrictionsForYourPublicRepos",
+ "method": "PUT",
+ "url": "/user/interaction-limits",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user.",
+ "documentationUrl": "https://docs.github.com/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories",
+ "previews": [],
+ "headers": [],
+ "parameters": [
{
- "code": 404,
- "description": "Otherwise a `404` status code is returned.",
+ "name": "limit",
+ "description": "The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": ["existing_users", "contributors_only", "collaborators_only"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "expiry",
+ "description": "The duration of the interaction restriction. Default: `one_day`.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": [
+ "one_day",
+ "three_days",
+ "one_week",
+ "one_month",
+ "six_months"
+ ],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"limit\":\"collaborators_only\",\"origin\":\"user\",\"expires_at\":\"2018-08-17T04:18:39Z\"}"
+ }
+ ]
+ },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
"examples": null
}
],
+ "renamed": {
+ "before": {
+ "scope": "interactions",
+ "id": "setRestrictionsForYourPublicRepos"
+ },
+ "after": {
+ "scope": "interactions",
+ "id": "setRestrictionsForAuthenticatedUser"
+ },
+ "date": "2021-02-02",
+ "note": null
+ }
+ },
+ {
+ "name": "Add assignees to an issue",
+ "scope": "issues",
+ "id": "addAssignees",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.",
+ "documentationUrl": "https://docs.github.com/rest/reference/issues#add-assignees-to-an-issue",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "issue_number",
+ "description": "The number that identifies the issue.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "assignees",
+ "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._",
+ "in": "BODY",
+ "type": "string[]",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}"
+ }
+ ]
+ }
+ ],
"renamed": null
},
{
- "name": "Check if a user can be assigned to a issue",
+ "name": "Add labels to an issue",
"scope": "issues",
- "id": "checkUserCanBeAssignedToIssue",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}",
+ "id": "addLabels",
+ "method": "POST",
+ "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.",
- "documentationUrl": "https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue",
+ "description": "",
+ "documentationUrl": "https://docs.github.com/rest/reference/issues#add-labels-to-an-issue",
"previews": [],
"headers": [],
"parameters": [
@@ -27016,6 +24750,94 @@
"alias": null,
"deprecated": null
},
+ {
+ "name": "labels",
+ "description": "",
+ "in": "BODY",
+ "type": "object[]",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "labels[].name",
+ "description": "",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
+ }
+ ]
+ },
+ { "code": 301, "description": "Moved permanently", "examples": null },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ { "code": 410, "description": "Gone", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Check if a user can be assigned",
+ "scope": "issues",
+ "id": "checkUserCanBeAssigned",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/assignees/{assignee}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
+ "documentationUrl": "https://docs.github.com/rest/reference/issues#check-if-a-user-can-be-assigned",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
{
"name": "assignee",
"description": "",
@@ -27033,12 +24855,12 @@
"responses": [
{
"code": 204,
- "description": "Response if `assignee` can be assigned to `issue_number`",
+ "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.",
"examples": null
},
{
"code": 404,
- "description": "Response if `assignee` can not be assigned to `issue_number`",
+ "description": "Otherwise a `404` status code is returned.",
"examples": null
}
],
@@ -27667,7 +25489,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/issues#get-an-issue",
"previews": [],
"headers": [],
@@ -28012,7 +25834,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/issues#list-issues-assigned-to-the-authenticated-user",
"previews": [],
"headers": [],
@@ -28798,7 +26620,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user",
"previews": [],
"headers": [],
@@ -28939,7 +26761,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user",
"previews": [],
"headers": [],
@@ -29092,7 +26914,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
+ "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"documentationUrl": "https://docs.github.com/rest/reference/issues#list-repository-issues",
"previews": [],
"headers": [],
@@ -29732,7 +27554,7 @@
},
{
"name": "lock_reason",
- "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`",
+ "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`",
"in": "BODY",
"type": "string",
"required": false,
@@ -30154,7 +27976,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Issue owners and users with push access can edit an issue.",
- "documentationUrl": "https://docs.github.com/rest/reference/issues#update-an-issue",
+ "documentationUrl": "https://docs.github.com/rest/reference/issues/#update-an-issue",
"previews": [],
"headers": [],
"parameters": [
@@ -30856,11 +28678,7 @@
}
],
"responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [{ "data": "\"Hello world \"" }]
- },
+ { "code": 200, "description": "Response", "examples": null },
{ "code": 304, "description": "Not modified", "examples": null }
],
"renamed": null
@@ -30900,11 +28718,7 @@
}
],
"responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [{ "data": "\"Hello world \"" }]
- },
+ { "code": 200, "description": "Response", "examples": null },
{ "code": 304, "description": "Not modified", "examples": null }
],
"renamed": null
@@ -30937,32 +28751,6 @@
],
"renamed": null
},
- {
- "name": "Get all API versions",
- "scope": "meta",
- "id": "getAllVersions",
- "method": "GET",
- "url": "/versions",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Get all supported GitHub API versions.",
- "documentationUrl": "https://docs.github.com/rest/reference/meta#get-all-api-versions",
- "previews": [],
- "headers": [],
- "parameters": [],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- { "data": "[\"2021-01-01\",\"2021-06-01\",\"2022-01-01\"]" }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
- ],
- "renamed": null
- },
{
"name": "Get Octocat",
"scope": "meta",
@@ -31014,7 +28802,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Get a random sentence from the Zen of GitHub",
- "documentationUrl": "https://docs.github.com/rest/meta#get-the-zen-of-github",
+ "documentationUrl": "",
"previews": [],
"headers": [],
"parameters": [],
@@ -31095,14 +28883,7 @@
"deprecated": null
}
],
- "responses": [
- { "code": 204, "description": "Response", "examples": null },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
- }
- ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
"renamed": null
},
{
@@ -31344,12 +29125,7 @@
}
]
},
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
- }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
@@ -31404,12 +29180,7 @@
}
]
},
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
- }
+ { "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
@@ -31463,11 +29234,6 @@
"data": "[{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/1\",\"oid\":\"d3d9446802a44259755d38e6d163e820\",\"size\":10485760},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/2\",\"oid\":\"6512bd43d9caa6e02c990b0a82652dca\",\"size\":11534336},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/3\",\"oid\":\"c20ad4d76fe97759aa27a0c99bff6710\",\"size\":12582912}]"
}
]
- },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
}
],
"renamed": null
@@ -31803,7 +29569,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
},
@@ -31884,7 +29650,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
},
@@ -31952,7 +29718,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
},
@@ -32060,11 +29826,6 @@
"code": 422,
"description": "Validation failed, or the endpoint has been spammed.",
"examples": null
- },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
}
],
"renamed": null
@@ -32137,11 +29898,6 @@
"code": 422,
"description": "Validation failed, or the endpoint has been spammed.",
"examples": null
- },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
}
],
"renamed": null
@@ -32588,11 +30344,6 @@
"code": 422,
"description": "Validation failed, or the endpoint has been spammed.",
"examples": null
- },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
}
],
"renamed": null
@@ -32819,11 +30570,6 @@
"data": "{\"vcs\":\"subversion\",\"use_lfs\":true,\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}"
}
]
- },
- {
- "code": 503,
- "description": "Unavailable due to service under maintenance.",
- "examples": null
}
],
"renamed": null
@@ -32939,7 +30685,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).",
+ "description": "Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).",
"documentationUrl": "https://docs.github.com/rest/reference/orgs#cancel-an-organization-invitation",
"previews": [],
"headers": [],
@@ -33161,7 +30907,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"",
+ "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"",
"documentationUrl": "https://docs.github.com/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator",
"previews": [],
"headers": [],
@@ -33215,13 +30961,112 @@
{ "code": 204, "description": "User was converted", "examples": null },
{
"code": 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](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"",
+ "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](https://docs.github.com/en/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"",
"examples": null
},
{ "code": 404, "description": "Resource not found", "examples": null }
],
"renamed": null
},
+ {
+ "name": "Create a custom role",
+ "scope": "orgs",
+ "id": "createCustomRole",
+ "method": "POST",
+ "url": "/orgs/{org}/custom_roles",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "**Note**: This operation is in beta and is subject to change.\n\nCreates a custom repository role that can be used by all repositories owned by the organization.\n\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.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs#create-a-custom-role",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "name",
+ "description": "The name of the custom role.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "description",
+ "description": "A short description about the intended usage of this role or what permissions it grants.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "base_role",
+ "description": "The system role from which this role inherits permissions.",
+ "in": "BODY",
+ "type": "string",
+ "required": true,
+ "enum": ["read", "triage", "write", "maintain"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "permissions",
+ "description": "A list of additional permissions included in this role.",
+ "in": "BODY",
+ "type": "string[]",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"id\":8030,\"name\":\"Labeler\",\"description\":\"A role for issue and PR labelers\",\"base_role\":\"read\",\"permissions\":[\"add_label\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:19:11Z\"}"
+ }
+ ]
+ },
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
+ ],
+ "renamed": null
+ },
{
"name": "Create an organization invitation",
"scope": "orgs",
@@ -33231,7 +31076,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/orgs#create-an-organization-invitation",
"previews": [],
"headers": [],
@@ -33277,7 +31122,7 @@
},
{
"name": "role",
- "description": "The role for the new member. \n * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.",
+ "description": "The role for the new member. \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.",
"in": "BODY",
"type": "string",
"required": false,
@@ -33308,7 +31153,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}"
+ "data": "{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}"
}
]
},
@@ -33454,7 +31299,7 @@
},
{
"name": "events",
- "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.",
+ "description": "Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.",
"in": "BODY",
"type": "string[]",
"required": false,
@@ -33498,6 +31343,50 @@
],
"renamed": null
},
+ {
+ "name": "Delete a custom role",
+ "scope": "orgs",
+ "id": "deleteCustomRole",
+ "method": "DELETE",
+ "url": "/orgs/{org}/custom_roles/{role_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "**Note**: This operation is in beta and is subject to change.\n\nDeletes 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.\n\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.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "role_id",
+ "description": "The unique identifier of the role.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
{
"name": "Delete an organization webhook",
"scope": "orgs",
@@ -34088,26 +31977,41 @@
"validation": null,
"alias": null,
"deprecated": null
- },
+ }
+ ],
+ "responses": [
{
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "List custom repository roles in an organization",
+ "scope": "orgs",
+ "id": "listCustomRoles",
+ "method": "GET",
+ "url": "/organizations/{organization_id}/custom_roles",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "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.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-custom-repository-roles-in-an-organization",
+ "previews": [],
+ "headers": [],
+ "parameters": [
{
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
+ "name": "organization_id",
+ "description": "The unique identifier of the organization.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
"enum": null,
"allowNull": false,
"mapToData": null,
@@ -34119,10 +32023,10 @@
"responses": [
{
"code": 200,
- "description": "Response",
+ "description": "Response - list of custom role names",
"examples": [
{
- "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
+ "data": "{\"total_count\":2,\"custom_roles\":[{\"id\":8030,\"name\":\"Security Engineer\",\"description\":\"Able to contribute code and maintain the security pipeline\",\"base_role\":\"maintain\",\"permissions\":[\"delete_alerts_code_scanning\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:20:11Z\"},{\"id\":8031,\"name\":\"Community manager\",\"description\":\"Able to handle all the community interactions without being able to contribute code\",\"base_role\":\"read\",\"permissions\":[\"mark_as_duplicate\",\"manage_settings_pages\",\"manage_settings_wiki\",\"set_social_preview\",\"edit_repo_metadata\",\"toggle_discussion_comment_minimize\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-05T12:01:11Z\",\"updated_at\":\"2022-07-05T12:20:11Z\"}]}"
}
]
}
@@ -34189,7 +32093,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]"
+ "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]"
}
]
},
@@ -34197,6 +32101,47 @@
],
"renamed": null
},
+ {
+ "name": "List fine-grained permissions for an organization",
+ "scope": "orgs",
+ "id": "listFineGrainedPermissions",
+ "method": "GET",
+ "url": "/orgs/{org}/fine_grained_permissions",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "**Note**: This operation is in beta and subject to change.\n\nLists the fine-grained permissions available for an organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "[{\"name\":\"add_assignee\",\"description\":\"Assign or remove a user\"},{\"name\":\"remove_assignee\",\"description\":\"Remove an assigned user\"},{\"name\":\"add_label\",\"description\":\"Add or remove a label\"}]"
+ }
+ ]
+ }
+ ],
+ "renamed": null
+ },
{
"name": "List organizations for the authenticated user",
"scope": "orgs",
@@ -34723,7 +32668,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]"
+ "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]"
}
]
},
@@ -34904,19 +32849,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "redelivery",
- "description": "",
- "in": "QUERY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -35109,11 +33041,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{
@@ -35404,7 +33332,7 @@
},
{
"name": "role",
- "description": "The role to give the user in the organization. Can be one of: \n * `admin` - The user will become an owner of the organization. \n * `member` - The user will become a non-owner member of the organization.",
+ "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.",
"in": "BODY",
"type": "string",
"required": false,
@@ -35536,7 +33464,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
- "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-an-organization",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs/#update-an-organization",
"previews": [],
"headers": [],
"parameters": [
@@ -35903,12 +33831,68 @@
"validation": null,
"alias": null,
"deprecated": null
+ }
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "description": "Response",
+ "examples": [
+ {
+ "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\"}"
+ }
+ ]
+ },
+ { "code": 409, "description": "Conflict", "examples": null },
+ { "code": 422, "description": "Validation failed", "examples": null }
+ ],
+ "renamed": null
+ },
+ {
+ "name": "Update a custom role",
+ "scope": "orgs",
+ "id": "updateCustomRole",
+ "method": "PATCH",
+ "url": "/orgs/{org}/custom_roles/{role_id}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "**Note**: This operation is in beta and subject to change.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization.\n\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.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/orgs#update-a-custom-role",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "org",
+ "description": "The organization name. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "role_id",
+ "description": "The unique identifier of the role.",
+ "in": "PATH",
+ "type": "integer",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
},
{
- "name": "secret_scanning_push_protection_custom_link_enabled",
- "description": "Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.",
+ "name": "name",
+ "description": "The name of the custom role.",
"in": "BODY",
- "type": "boolean",
+ "type": "string",
"required": false,
"enum": null,
"allowNull": false,
@@ -35918,8 +33902,8 @@
"deprecated": null
},
{
- "name": "secret_scanning_push_protection_custom_link",
- "description": "If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret.",
+ "name": "description",
+ "description": "A short description about who this role is for or what permissions it grants.",
"in": "BODY",
"type": "string",
"required": false,
@@ -35929,6 +33913,32 @@
"validation": null,
"alias": null,
"deprecated": null
+ },
+ {
+ "name": "base_role",
+ "description": "The system role from which this role inherits permissions.",
+ "in": "BODY",
+ "type": "string",
+ "required": false,
+ "enum": ["read", "triage", "write", "maintain"],
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "permissions",
+ "description": "A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role.",
+ "in": "BODY",
+ "type": "string[]",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
"responses": [
@@ -35937,12 +33947,16 @@
"description": "Response",
"examples": [
{
- "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"members_can_fork_private_repositories\":false,\"web_commit_signoff_required\":false,\"updated_at\":\"2014-03-03T18:58:10Z\"}"
+ "data": "{\"id\":8030,\"name\":\"Labeler\",\"description\":\"A role for issue and PR labelers\",\"base_role\":\"read\",\"permissions\":[\"add_label\",\"remove_label\"],\"organization\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"created_at\":\"2022-07-04T22:19:11Z\",\"updated_at\":\"2022-07-04T22:19:11Z\"}"
}
]
},
- { "code": 409, "description": "Conflict", "examples": null },
- { "code": 422, "description": "Validation failed", "examples": null }
+ { "code": 404, "description": "Resource not found", "examples": null },
+ {
+ "code": 422,
+ "description": "Validation failed, or the endpoint has been spammed.",
+ "examples": null
+ }
],
"renamed": null
},
@@ -36286,7 +34300,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -36339,7 +34353,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-an-organization",
"previews": [],
"headers": [],
@@ -36405,7 +34419,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-for-a-user",
"previews": [],
"headers": [],
@@ -36471,7 +34485,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes.\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -36537,7 +34551,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-an-organization",
"previews": [],
"headers": [],
@@ -36616,7 +34630,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container you want to delete.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#delete-a-package-version-for-a-user",
"previews": [],
"headers": [],
@@ -36695,7 +34709,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
"previews": [],
"headers": [],
@@ -36819,7 +34833,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
"previews": [],
"headers": [],
@@ -36930,7 +34944,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user",
"previews": [],
"headers": [],
@@ -37030,7 +35044,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists package versions for a package owned by an organization.\n\nIf the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization",
"previews": [],
"headers": [],
@@ -37143,7 +35157,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user",
"previews": [],
"headers": [],
@@ -37217,7 +35231,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -37271,7 +35285,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package in an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package in an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-an-organization",
"previews": [],
"headers": [],
@@ -37338,7 +35352,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package metadata for a public package owned by a user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package metadata for a public package owned by a user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-for-a-user",
"previews": [],
"headers": [],
@@ -37405,7 +35419,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package version for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package version for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -37472,7 +35486,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package version in an organization.\n\nYou must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-an-organization",
"previews": [],
"headers": [],
@@ -37552,7 +35566,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a specific package version for a public package owned by a specified user.\n\nAt this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Gets a specific package version for a public package owned by a specified user.\n\nAt this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#get-a-package-version-for-a-user",
"previews": [],
"headers": [],
@@ -37632,7 +35646,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists packages owned by the authenticated user within the user's namespace.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -37652,7 +35666,7 @@
},
{
"name": "visibility",
- "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\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](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -37686,7 +35700,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists all packages in an organization readable by the user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-an-organization",
"previews": [],
"headers": [],
@@ -37719,7 +35733,7 @@
},
{
"name": "visibility",
- "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\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](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -37759,7 +35773,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Lists all packages in a user's namespace for which the requesting user has access.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#list-packages-for-user",
"previews": [],
"headers": [],
@@ -37779,7 +35793,7 @@
},
{
"name": "visibility",
- "description": "The selected visibility of the packages. This parameter is optional and only filters an existing result set.\n\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](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "The selected visibility of the packages. Only `container` package_types currently support `internal` visibility properly. For other ecosystems `internal` is synonymous with `private`. This parameter is optional and only filters an existing result set.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -37832,7 +35846,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -37898,7 +35912,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Restores an entire package in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-an-organization",
"previews": [],
"headers": [],
@@ -37977,7 +35991,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Restores an entire package for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-for-a-user",
"previews": [],
"headers": [],
@@ -38056,7 +36070,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"",
+ "description": "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user",
"previews": [],
"headers": [],
@@ -38122,7 +36136,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Restores a specific package version in an organization.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-an-organization",
"previews": [],
"headers": [],
@@ -38201,7 +36215,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:\n- If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"\n- If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages).\"",
+ "description": "Restores a specific package version for a user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:\n- If `package_type` is not `container`, your token must also include the `repo` scope.\n- If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.",
"documentationUrl": "https://docs.github.com/rest/reference/packages#restore-a-package-version-for-a-user",
"previews": [],
"headers": [],
@@ -39400,7 +37414,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":true}]"
+ "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]"
}
]
},
@@ -40142,7 +38156,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
+ "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-pull-request",
"previews": [],
"headers": [],
@@ -40240,7 +38254,7 @@
},
{
"name": "draft",
- "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.",
+ "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.",
"in": "BODY",
"type": "boolean",
"required": false,
@@ -40271,7 +38285,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
}
]
},
@@ -40293,7 +38307,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment",
"previews": [],
"headers": [],
@@ -40387,7 +38401,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
+ "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-review-for-a-pull-request",
"previews": [],
"headers": [],
@@ -40603,7 +38617,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request",
"previews": [],
"headers": [],
@@ -40701,7 +38715,7 @@
},
{
"name": "side",
- "description": "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](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
+ "description": "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](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.",
"in": "BODY",
"type": "string",
"required": false,
@@ -40727,7 +38741,7 @@
},
{
"name": "start_line",
- "description": "**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](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
+ "description": "**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](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.",
"in": "BODY",
"type": "integer",
"required": false,
@@ -40740,7 +38754,7 @@
},
{
"name": "start_side",
- "description": "**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](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
+ "description": "**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](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.",
"in": "BODY",
"type": "string",
"required": false,
@@ -41102,7 +39116,7 @@
"description": "Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
}
]
},
@@ -42218,7 +40232,7 @@
},
{
"name": "merge_method",
- "description": "The merge method to use.",
+ "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
"in": "BODY",
"type": "string",
"required": false,
@@ -42701,7 +40715,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"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,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"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,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
}
]
},
@@ -45513,8 +43527,8 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified 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.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-app-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -45546,7 +43560,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -45598,7 +43612,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nAdding an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:\n\n```\nCannot assign {member} permission of {role name}\n```\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.",
"documentationUrl": "https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator",
"previews": [],
"headers": [],
@@ -45690,7 +43704,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-status-check-contexts",
"previews": [],
"headers": [],
"parameters": [
@@ -45722,7 +43736,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -45777,7 +43791,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-team-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -45809,7 +43823,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -45862,7 +43876,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#add-user-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -45894,7 +43908,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -46014,7 +44028,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "description": "Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
"documentationUrl": "https://docs.github.com/rest/reference/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository",
"previews": [],
"headers": [],
@@ -46245,7 +44259,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "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](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).\"\n\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](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe 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.\n\nWhen 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.\n\n**Working with large comparisons**\n\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:\n\n- The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.\n- The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.\n\nFor more information on working with pagination, see \"[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\"\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
+ "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
"documentationUrl": "https://docs.github.com/rest/commits/commits#compare-two-commits",
"previews": [],
"headers": [],
@@ -46304,7 +44318,7 @@
},
{
"name": "basehead",
- "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.",
+ "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
"in": "PATH",
"type": "string",
"required": true,
@@ -46439,7 +44453,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/commits/comments#create-a-commit-comment",
"previews": [],
"headers": [],
@@ -46565,7 +44579,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#create-commit-signature-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -46597,7 +44611,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -46752,7 +44766,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "You can create a read-only deploy key.",
- "documentationUrl": "https://docs.github.com/rest/deploy-keys#create-a-deploy-key",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deploy-key",
"previews": [],
"headers": [],
"parameters": [
@@ -46850,7 +44864,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Deployments offer a few configurable parameters with certain defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them\nbefore we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.\n\nBy default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
- "documentationUrl": "https://docs.github.com/rest/deployments/deployments#create-a-deployment",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deployment",
"previews": [],
"headers": [],
"parameters": [
@@ -47133,7 +45147,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.",
- "documentationUrl": "https://docs.github.com/rest/deployments/statuses#create-a-deployment-status",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-deployment-status",
"previews": [],
"headers": [],
"parameters": [
@@ -47349,7 +45363,7 @@
},
{
"name": "client_payload",
- "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.",
+ "description": "JSON payload with extra information about the webhook event that your action or workflow may use.",
"in": "BODY",
"type": "object",
"required": false,
@@ -47489,19 +45503,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "has_discussions",
- "description": "Whether discussions are enabled.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "team_id",
"description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
@@ -47909,11 +45910,11 @@
},
{
"name": "visibility",
- "description": "The visibility of the repository.",
+ "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.",
"in": "BODY",
"type": "string",
"required": false,
- "enum": ["public", "private"],
+ "enum": ["public", "private", "internal"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -47959,19 +45960,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "has_downloads",
- "description": "Whether downloads are enabled.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "is_template",
"description": "Either `true` to make this repo available as a template repository or `false` to prevent it.",
@@ -48197,7 +46185,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/deployments/environments#create-or-update-an-environment",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment",
"previews": [],
"headers": [],
"parameters": [
@@ -48712,7 +46700,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.",
+ "description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
"documentationUrl": "https://docs.github.com/rest/pages#create-a-github-pages-site",
"previews": [],
"headers": [],
@@ -48824,7 +46812,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#create-a-release",
"previews": [],
"headers": [],
@@ -48958,19 +46946,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "make_latest",
- "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["true", "false", "legacy"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -49520,7 +47495,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -49552,7 +47527,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -49577,7 +47552,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-admin-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -49609,7 +47584,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -49637,7 +47612,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "You must authenticate using an access token with the repo scope to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/deployments/environments#delete-an-environment",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-an-environment",
"previews": [],
"headers": [],
"parameters": [
@@ -49756,7 +47731,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#delete-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -49788,7 +47763,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -49876,7 +47851,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-commit-signature-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -49908,7 +47883,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -49936,7 +47911,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.",
- "documentationUrl": "https://docs.github.com/rest/deploy-keys#delete-a-deploy-key",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-deploy-key",
"previews": [],
"headers": [],
"parameters": [
@@ -49992,8 +47967,8 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status).\"",
- "documentationUrl": "https://docs.github.com/rest/deployments/deployments#delete-a-deployment",
+ "description": "If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status).\"",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-a-deployment",
"previews": [],
"headers": [],
"parameters": [
@@ -50376,7 +48351,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Deletes a a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.",
+ "description": "",
"documentationUrl": "https://docs.github.com/rest/pages#delete-a-github-pages-site",
"previews": [],
"headers": [],
@@ -50430,7 +48405,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#delete-pull-request-review-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -50462,7 +48437,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -50724,7 +48699,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".",
+ "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)\".",
"documentationUrl": "https://docs.github.com/rest/reference/repos#disable-automated-security-fixes",
"previews": [],
"headers": [],
@@ -50768,7 +48743,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.",
+ "description": "",
"documentationUrl": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository",
"previews": [],
"headers": [],
@@ -50812,7 +48787,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
"documentationUrl": "https://docs.github.com/rest/reference/repos#disable-vulnerability-alerts",
"previews": [],
"headers": [],
@@ -50856,7 +48831,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive",
"previews": [],
"headers": [],
@@ -50918,7 +48893,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.",
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive",
"previews": [],
"headers": [],
@@ -50980,7 +48955,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
+ "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive",
"previews": [],
"headers": [],
@@ -51010,172 +48985,168 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "ref",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 302, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Download a repository archive (zip)",
- "scope": "repos",
- "id": "downloadZipballArchive",
- "method": "GET",
- "url": "/repos/{owner}/{repo}/zipball/{ref}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.",
- "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "ref",
- "description": "",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 302, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Enable automated security fixes",
- "scope": "repos",
- "id": "enableAutomatedSecurityFixes",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/automated-security-fixes",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)\".",
- "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-automated-security-fixes",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [{ "code": 204, "description": "Response", "examples": null }],
- "renamed": null
- },
- {
- "name": "Enable Git LFS for a repository",
- "scope": "repos",
- "id": "enableLfsForRepo",
- "method": "PUT",
- "url": "/repos/{owner}/{repo}/lfs",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.",
- "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "owner",
- "description": "The account owner of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "repo",
- "description": "The name of the repository. The name is not case sensitive.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
+ },
+ {
+ "name": "ref",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
}
],
- "responses": [
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Download a repository archive (zip)",
+ "scope": "repos",
+ "id": "downloadZipballArchive",
+ "method": "GET",
+ "url": "/repos/{owner}/{repo}/zipball/{ref}",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#download-a-repository-archive",
+ "previews": [],
+ "headers": [],
+ "parameters": [
{
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "ref",
+ "description": "",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 302, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Enable automated security fixes",
+ "scope": "repos",
+ "id": "enableAutomatedSecurityFixes",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/automated-security-fixes",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)\".",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-automated-security-fixes",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [{ "code": 204, "description": "Response", "examples": null }],
+ "renamed": null
+ },
+ {
+ "name": "Enable Git LFS for a repository",
+ "scope": "repos",
+ "id": "enableLfsForRepo",
+ "method": "PUT",
+ "url": "/repos/{owner}/{repo}/lfs",
+ "isDeprecated": false,
+ "deprecationDate": null,
+ "removalDate": null,
+ "description": "",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository",
+ "previews": [],
+ "headers": [],
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "The account owner of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
},
+ {
+ "name": "repo",
+ "description": "The name of the repository. The name is not case sensitive.",
+ "in": "PATH",
+ "type": "string",
+ "required": true,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ }
+ ],
+ "responses": [
+ { "code": 202, "description": "Accepted", "examples": null },
{
"code": 403,
"description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .",
@@ -51193,7 +49164,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)\".",
+ "description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
"documentationUrl": "https://docs.github.com/rest/reference/repos#enable-vulnerability-alerts",
"previews": [],
"headers": [],
@@ -51344,7 +49315,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
+ "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-repository",
"previews": [],
"headers": [],
@@ -51382,7 +49353,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1,\"security_and_analysis\":{\"advanced_security\":{\"status\":\"enabled\"},\"secret_scanning\":{\"status\":\"enabled\"},\"secret_scanning_push_protection\":{\"status\":\"disabled\"}}}}"
+ "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"forks\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"open_issues\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"push\":false,\"admin\":false},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}"
}
]
},
@@ -51402,7 +49373,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -51434,7 +49405,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -51470,7 +49441,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-admin-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -51502,7 +49473,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -51617,7 +49588,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-all-status-check-contexts",
"previews": [],
"headers": [],
"parameters": [
@@ -51649,7 +49620,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -51760,7 +49731,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-apps-with-access-to-the-protected-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -51792,7 +49763,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -51896,7 +49867,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/branches/branches#get-a-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -51928,7 +49899,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -51965,7 +49936,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -51997,7 +49968,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -52015,7 +49986,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"require_last_push_approval\":true},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true},\"lock_branch\":{\"enabled\":true},\"allow_fork_syncing\":{\"enabled\":true}}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}"
}
]
},
@@ -52138,11 +50109,7 @@
"description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.",
"examples": [{ "data": "[[1302998400,1124,-435]]" }]
},
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{
"code": 204,
"description": "A header with no content is returned.",
@@ -52465,11 +50432,7 @@
}
]
},
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{
"code": 204,
"description": "A header with no content is returned.",
@@ -52556,7 +50519,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-commit-signature-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -52588,7 +50551,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -52623,7 +50586,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
+ "description": "Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.",
"documentationUrl": "https://docs.github.com/rest/metrics/community#get-community-profile-metrics",
"previews": [],
"headers": [],
@@ -52736,24 +50699,13 @@
}
],
"responses": [
+ { "code": 200, "description": "Response", "examples": null },
{
"code": 200,
"description": "Response",
"examples": [
{
- "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}"
- },
- {
- "data": "{\"type\":\"dir\",\"size\":0,\"name\":\"src\",\"path\":\"src\",\"sha\":\"2962be1c94eaae9794b3080790ec9d74b2fa8358\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src?ref=main\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src\"},\"entries\":[{\"type\":\"file\",\"size\":625,\"name\":\"app.js\",\"path\":\"src/app.js\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"images\",\"path\":\"src/images\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octocat/octorepo/tree/main/src/images\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octocat/octorepo/tree/main/src/images\"}}]}"
- }
- ]
- },
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}"
+ "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}"
},
{
"data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]"
@@ -52823,11 +50775,7 @@
}
]
},
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{
"code": 204,
"description": "A header with no content is returned.",
@@ -52846,7 +50794,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/deploy-keys#get-a-deploy-key",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deploy-key",
"previews": [],
"headers": [],
"parameters": [
@@ -52914,7 +50862,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/deployments/deployments#get-a-deployment",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deployment",
"previews": [],
"headers": [],
"parameters": [
@@ -53062,7 +51010,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Users with pull access can view a deployment status for a deployment:",
- "documentationUrl": "https://docs.github.com/rest/deployments/statuses#get-a-deployment-status",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-a-deployment-status",
"previews": [],
"headers": [],
"parameters": [
@@ -53143,7 +51091,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.",
- "documentationUrl": "https://docs.github.com/rest/deployments/environments#get-an-environment",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-an-environment",
"previews": [],
"headers": [],
"parameters": [
@@ -53439,7 +51387,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.",
+ "description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nUsers must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.",
"documentationUrl": "https://docs.github.com/rest/pages#get-a-dns-health-check-for-github-pages",
"previews": [],
"headers": [],
@@ -53565,7 +51513,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-pull-request-review-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -53597,7 +51545,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -53615,7 +51563,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"require_last_push_approval\":true}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}"
}
]
}
@@ -54051,7 +51999,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#get-status-checks-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -54083,7 +52031,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -54119,7 +52067,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-teams-with-access-to-the-protected-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -54151,7 +52099,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -54297,7 +52245,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-users-with-access-to-the-protected-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -54329,7 +52277,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -54722,7 +52670,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/branches/branches#list-branches",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-branches",
"previews": [],
"headers": [],
"parameters": [
@@ -55294,7 +53242,7 @@
},
{
"name": "sha",
- "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).",
+ "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).",
"in": "QUERY",
"type": "string",
"required": false,
@@ -55411,7 +53359,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
+ "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#list-repository-contributors",
"previews": [],
"headers": [],
@@ -55512,7 +53460,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/deploy-keys#list-deploy-keys",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deploy-keys",
"previews": [],
"headers": [],
"parameters": [
@@ -55685,7 +53633,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Users with pull access can view deployment statuses for a deployment:",
- "documentationUrl": "https://docs.github.com/rest/deployments/statuses#list-deployment-statuses",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deployment-statuses",
"previews": [],
"headers": [],
"parameters": [
@@ -55779,7 +53727,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Simple filtering of deployments is available via query parameters:",
- "documentationUrl": "https://docs.github.com/rest/deployments/deployments#list-deployments",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#list-deployments",
"previews": [],
"headers": [],
"parameters": [
@@ -55930,7 +53878,7 @@
},
{
"name": "affiliation",
- "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
+ "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -56067,7 +54015,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists repositories for the specified organization.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"",
+ "description": "Lists repositories for the specified organization.",
"documentationUrl": "https://docs.github.com/rest/reference/repos#list-organization-repositories",
"previews": [],
"headers": [],
@@ -56087,11 +54035,19 @@
},
{
"name": "type",
- "description": "Specifies the types of repositories you want returned.",
+ "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.",
"in": "QUERY",
"type": "string",
"required": false,
- "enum": ["all", "public", "private", "forks", "sources", "member"],
+ "enum": [
+ "all",
+ "public",
+ "private",
+ "forks",
+ "sources",
+ "member",
+ "internal"
+ ],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -56157,7 +54113,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
}
@@ -56263,7 +54219,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
}
@@ -56693,7 +54649,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.",
+ "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.",
"documentationUrl": "https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit",
"previews": [],
"headers": [],
@@ -57241,19 +55197,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "redelivery",
- "description": "",
- "in": "QUERY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -57367,7 +55310,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "",
- "documentationUrl": "https://docs.github.com/rest/branches/branches#merge-a-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#merge-a-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -57481,7 +55424,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
- "documentationUrl": "https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -57676,11 +55619,7 @@
}
],
"responses": [
- {
- "code": 202,
- "description": "Accepted",
- "examples": [{ "data": "null" }]
- },
+ { "code": 202, "description": "Accepted", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{ "code": 400, "description": "Bad Request", "examples": null },
{
@@ -57700,8 +55639,8 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\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.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-app-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -57733,7 +55672,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -57843,7 +55782,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-contexts",
"previews": [],
"headers": [],
"parameters": [
@@ -57875,7 +55814,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -57925,7 +55864,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-status-check-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -57957,7 +55896,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -57982,7 +55921,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-team-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -58014,7 +55953,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58067,7 +56006,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#remove-user-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -58099,7 +56038,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58152,7 +56091,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Renames a branch in a repository.\n\n**Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)\".\n\nThe permissions required to use this endpoint depends on whether you are renaming the default branch.\n\nTo rename a non-default branch:\n\n* Users must have push access.\n* GitHub Apps must have the `contents:write` repository permission.\n\nTo rename the default branch:\n\n* Users must have admin or owner permissions.\n* GitHub Apps must have the `administration:write` repository permission.",
- "documentationUrl": "https://docs.github.com/rest/branches/branches#rename-a-branch",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#rename-a-branch",
"previews": [],
"headers": [],
"parameters": [
@@ -58184,7 +56123,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58364,7 +56303,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#set-admin-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -58396,7 +56335,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58430,8 +56369,8 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\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.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions",
+ "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#set-app-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -58463,7 +56402,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58516,7 +56455,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#set-status-check-contexts",
"previews": [],
"headers": [],
"parameters": [
@@ -58548,7 +56487,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58598,7 +56537,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#set-team-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -58630,7 +56569,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58683,7 +56622,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#set-user-access-restrictions",
"previews": [],
"headers": [],
"parameters": [
@@ -58715,7 +56654,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -58871,19 +56810,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "new_name",
- "description": "The new name to be given to the repository.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "team_ids",
"description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
@@ -58921,7 +56847,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/reference/repos#replace-all-repository-topics) endpoint.",
- "documentationUrl": "https://docs.github.com/rest/repos/repos#update-a-repository",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos/#update-a-repository",
"previews": [],
"headers": [],
"parameters": [
@@ -59005,11 +56931,11 @@
},
{
"name": "visibility",
- "description": "The visibility of the repository.",
+ "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
"in": "BODY",
"type": "string",
"required": false,
- "enum": ["public", "private"],
+ "enum": ["public", "private", "internal"],
"allowNull": false,
"mapToData": null,
"validation": null,
@@ -59317,7 +57243,7 @@
},
{
"name": "archived",
- "description": "Whether to archive this repository. `false` will unarchive a previously archived repository.",
+ "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
"in": "BODY",
"type": "boolean",
"required": false,
@@ -59386,7 +57312,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#update-branch-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#update-branch-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -59418,7 +57344,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -59624,19 +57550,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "required_pull_request_reviews.require_last_push_approval",
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "required_pull_request_reviews.bypass_pull_request_allowances",
"description": "Allow specific users, teams, or apps to bypass pull request requirements.",
@@ -59756,7 +57669,7 @@
},
{
"name": "allow_force_pushes",
- "description": "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](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"",
+ "description": "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](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"",
"in": "BODY",
"type": "boolean",
"required": false,
@@ -59769,7 +57682,7 @@
},
{
"name": "allow_deletions",
- "description": "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](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
+ "description": "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](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.",
"in": "BODY",
"type": "boolean",
"required": false,
@@ -59805,32 +57718,6 @@
"validation": null,
"alias": null,
"deprecated": null
- },
- {
- "name": "lock_branch",
- "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "allow_fork_syncing",
- "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
}
],
"responses": [
@@ -59839,7 +57726,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts\",\"checks\":[{\"context\":\"continuous-integration/travis-ci\",\"app_id\":null}]},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps\",\"users\":[],\"teams\":[],\"apps\":[]},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews\",\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"require_last_push_approval\":true,\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams\",\"users\":[],\"teams\":[],\"apps\":[]}},\"required_signatures\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures\",\"enabled\":false},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins\",\"enabled\":true},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"block_creations\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true},\"lock_branch\":{\"enabled\":true},\"allow_fork_syncing\":{\"enabled\":true}}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts\",\"checks\":[{\"context\":\"continuous-integration/travis-ci\",\"app_id\":null}]},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps\",\"users\":[],\"teams\":[],\"apps\":[]},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews\",\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams\",\"users\":[],\"teams\":[],\"apps\":[]}},\"required_signatures\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures\",\"enabled\":false},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins\",\"enabled\":true},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"block_creations\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}"
}
]
},
@@ -60036,7 +57923,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\n\nTo use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.",
+ "description": "Updates information for a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).",
"documentationUrl": "https://docs.github.com/rest/pages#update-information-about-a-github-pages-site",
"previews": [],
"headers": [],
@@ -60093,6 +57980,19 @@
"alias": null,
"deprecated": null
},
+ {
+ "name": "public",
+ "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.",
+ "in": "BODY",
+ "type": "boolean",
+ "required": false,
+ "enum": null,
+ "allowNull": false,
+ "mapToData": null,
+ "validation": null,
+ "alias": null,
+ "deprecated": null
+ },
{
"name": "build_type",
"description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.",
@@ -60223,7 +58123,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#update-pull-request-review-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -60255,7 +58155,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -60357,19 +58257,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "require_last_push_approval",
- "description": "Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "bypass_pull_request_allowances",
"description": "Allow specific users, teams, or apps to bypass pull request requirements.",
@@ -60429,7 +58316,7 @@
"description": "Response",
"examples": [
{
- "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"require_last_push_approval\":true}"
+ "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}"
}
]
},
@@ -60572,19 +58459,6 @@
"alias": null,
"deprecated": null
},
- {
- "name": "make_latest",
- "description": "Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": ["true", "false", "legacy"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
{
"name": "discussion_category_name",
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\"",
@@ -60733,7 +58607,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#update-status-check-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -60765,7 +58639,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -60876,7 +58750,7 @@
"deprecationDate": null,
"removalDate": null,
"description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
- "documentationUrl": "https://docs.github.com/rest/branches/branch-protection#update-status-check-protection",
+ "documentationUrl": "https://docs.github.com/rest/reference/repos#update-status-check-protection",
"previews": [],
"headers": [],
"parameters": [
@@ -60908,7 +58782,7 @@
},
{
"name": "branch",
- "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql).",
+ "description": "The name of the branch.",
"in": "PATH",
"type": "string",
"required": true,
@@ -61573,7 +59447,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
+ "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match\nmetadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:\n\n`q=repo:octocat/Spoon-Knife+css`",
"documentationUrl": "https://docs.github.com/rest/reference/search#search-commits",
"previews": [],
"headers": [],
@@ -62227,48 +60101,6 @@
],
"renamed": null
},
- {
- "name": "Get code security and analysis features for an enterprise",
- "scope": "secretScanning",
- "id": "getSecurityAnalysisSettingsForEnterprise",
- "method": "GET",
- "url": "/enterprises/{enterprise}/code_security_and_analysis",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Gets code security and analysis settings for the specified enterprise.\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.",
- "documentationUrl": "https://docs.github.com/rest/enterprise-admin#get-code-security-analysis-features-for-an-enterprise",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "enterprise",
- "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- {
- "code": 200,
- "description": "Response",
- "examples": [
- {
- "data": "{\"advanced_security_enabled_for_new_repositories\":true,\"secret_scanning_enabled_for_new_repositories\":true,\"secret_scanning_push_protection_enabled_for_new_repositories\":true,\"secret_scanning_push_protection_custom_link\":\"https://github.com/test-org/test-repo/blob/main/README.md\"}"
- }
- ]
- },
- { "code": 404, "description": "Resource not found", "examples": null }
- ],
- "renamed": null
- },
{
"name": "List secret scanning alerts for an enterprise",
"scope": "secretScanning",
@@ -62376,7 +60208,7 @@
},
{
"name": "before",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -62389,7 +60221,7 @@
},
{
"name": "after",
- "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
+ "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.",
"in": "QUERY",
"type": "string",
"required": false,
@@ -62839,7 +60671,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"issue_title\",\"details\":{\"issue_title_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_body\",\"details\":{\"issue_body_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"}},{\"type\":\"issue_comment\",\"details\":{\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451\"}}]"
+ "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":5,\"end_line\":5,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_sha\":\"588483b99a46342501d99e3f10630cfc1219ea32\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":12,\"end_line\":12,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"commit_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065\"}}]"
}
]
},
@@ -62852,166 +60684,6 @@
],
"renamed": null
},
- {
- "name": "Update code security and analysis features for an enterprise",
- "scope": "secretScanning",
- "id": "patchSecurityAnalysisSettingsForEnterprise",
- "method": "PATCH",
- "url": "/enterprises/{enterprise}/code_security_and_analysis",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Updates the settings for advanced security, secret scanning, and push protection for new repositories in an enterprise.\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.",
- "documentationUrl": "https://docs.github.com/rest/enterprise-admin#update-code-security-and-analysis-features-for-an-enterprise",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "enterprise",
- "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "advanced_security_enabled_for_new_repositories",
- "description": "Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"[About GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security).\"",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_scanning_enabled_for_new_repositories",
- "description": "Whether secret scanning is automatically enabled for new repositories. For more information, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\"",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_scanning_push_protection_enabled_for_new_repositories",
- "description": "Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"[Protecting pushes with secret scanning](https://docs.github.com/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"",
- "in": "BODY",
- "type": "boolean",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "secret_scanning_push_protection_custom_link",
- "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](https://docs.github.com/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"\nTo disable this functionality, set this field to `null`.",
- "in": "BODY",
- "type": "string",
- "required": false,
- "enum": null,
- "allowNull": true,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Action started", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement",
- "examples": null
- }
- ],
- "renamed": null
- },
- {
- "name": "Enable or disable a security feature",
- "scope": "secretScanning",
- "id": "postSecurityProductEnablementForEnterprise",
- "method": "POST",
- "url": "/enterprises/{enterprise}/{security_product}/{enablement}",
- "isDeprecated": false,
- "deprecationDate": null,
- "removalDate": null,
- "description": "Enables or disables the specified security feature for all repositories in an enterprise.\n\nTo use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.",
- "documentationUrl": "https://docs.github.com/rest/enterprise-admin#enable-or-disable-a-security-feature",
- "previews": [],
- "headers": [],
- "parameters": [
- {
- "name": "enterprise",
- "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "security_product",
- "description": "The security feature to enable or disable.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": [
- "advanced_security",
- "secret_scanning",
- "secret_scanning_push_protection"
- ],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "enablement",
- "description": "The action to take.\n\n`enable_all` means to enable the specified security feature for all repositories in the enterprise.\n`disable_all` means to disable the specified security feature for all repositories in the enterprise.",
- "in": "PATH",
- "type": "string",
- "required": true,
- "enum": ["enable_all", "disable_all"],
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
- "responses": [
- { "code": 204, "description": "Action started", "examples": null },
- { "code": 404, "description": "Resource not found", "examples": null },
- {
- "code": 422,
- "description": "The action could not be taken due to an in progress enablement, or a policy is preventing enablement",
- "examples": null
- }
- ],
- "renamed": null
- },
{
"name": "Update a secret scanning alert",
"scope": "secretScanning",
@@ -63099,7 +60771,7 @@
},
{
"name": "resolution_comment",
- "description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.",
+ "description": "Sets an optional comment when closing an alert. Must be null when changing `state` to `open`.",
"in": "BODY",
"type": "string",
"required": false,
@@ -63206,7 +60878,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-membership-for-a-user",
"previews": [],
"headers": [],
@@ -63529,7 +61201,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
+ "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".",
"documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions",
"previews": [],
"headers": [],
@@ -63613,7 +61285,7 @@
"deprecationDate": "2020-01-21",
"removalDate": "2021-02-01",
"description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"[Add or update team repository permissions](https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions)\" endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs).\"",
- "documentationUrl": "https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions-legacy",
+ "documentationUrl": "https://docs.github.com/rest/reference/teams/#add-or-update-team-repository-permissions-legacy",
"previews": [],
"headers": [],
"parameters": [
@@ -63988,7 +61660,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
+ "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".",
"documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-team",
"previews": [],
"headers": [],
@@ -64060,7 +61732,7 @@
},
{
"name": "privacy",
- "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`",
+ "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`",
"in": "BODY",
"type": "string",
"required": false,
@@ -64126,7 +61798,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.",
+ "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment",
"previews": [],
"headers": [],
@@ -64206,7 +61878,7 @@
"isDeprecated": true,
"deprecationDate": "2020-01-21",
"removalDate": "2021-02-01",
- "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/reference/teams#create-a-discussion-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy",
"previews": [],
"headers": [],
@@ -64273,7 +61945,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.",
+ "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion",
"previews": [],
"headers": [],
@@ -64366,7 +62038,7 @@
"isDeprecated": true,
"deprecationDate": "2020-01-21",
"removalDate": "2021-02-01",
- "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
+ "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/reference/teams#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#create-a-discussion-legacy",
"previews": [],
"headers": [],
@@ -66202,7 +63874,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]"
+ "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]"
}
]
}
@@ -66269,7 +63941,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\",\"invitation_source\":\"member\"}]"
+ "data": "[{\"id\":1,\"login\":\"monalisa\",\"node_id\":\"MDQ6VXNlcjE=\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"failed_at\":\"\",\"failed_reason\":\"\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_teams_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]"
}
]
}
@@ -66497,7 +64169,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
}
@@ -66564,7 +64236,7 @@
"description": "Response",
"examples": [
{
- "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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\"}}}]"
+ "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"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,\"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},\"template_repository\":null}]"
}
]
},
@@ -66632,7 +64304,7 @@
"isDeprecated": false,
"deprecationDate": null,
"removalDate": null,
- "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
+ "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.",
"documentationUrl": "https://docs.github.com/rest/reference/teams#remove-team-membership-for-a-user",
"previews": [],
"headers": [],
@@ -67388,7 +65060,7 @@
},
{
"name": "privacy",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.",
"in": "BODY",
"type": "string",
"required": false,
@@ -67510,7 +65182,7 @@
},
{
"name": "privacy",
- "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.",
+ "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.",
"in": "BODY",
"type": "string",
"required": false,
@@ -69090,34 +66762,7 @@
"documentationUrl": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user",
"previews": [],
"headers": [],
- "parameters": [
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
+ "parameters": [],
"responses": [
{
"code": 200,
@@ -69157,34 +66802,7 @@
"documentationUrl": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user",
"previews": [],
"headers": [],
- "parameters": [
- {
- "name": "per_page",
- "description": "The number of results per page (max 100).",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- },
- {
- "name": "page",
- "description": "Page number of the results to fetch.",
- "in": "QUERY",
- "type": "integer",
- "required": false,
- "enum": null,
- "allowNull": false,
- "mapToData": null,
- "validation": null,
- "alias": null,
- "deprecated": null
- }
- ],
+ "parameters": [],
"responses": [
{
"code": 200,
diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts
index ad1925c0a..b279674da 100644
--- a/src/generated/endpoints.ts
+++ b/src/generated/endpoints.ts
@@ -10,21 +10,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
addSelectedRepoToOrgSecret: [
"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
],
- addSelectedRepoToOrgVariable: [
- "PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}",
- ],
- addSelectedRepoToRequiredWorkflow: [
- "PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}",
- ],
approveWorkflowRun: [
"POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve",
],
cancelWorkflowRun: [
"POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel",
],
- createEnvironmentVariable: [
- "POST /repositories/{repository_id}/environments/{environment_name}/variables",
- ],
createOrUpdateEnvironmentSecret: [
"PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
],
@@ -32,7 +23,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
createOrUpdateRepoSecret: [
"PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}",
],
- createOrgVariable: ["POST /orgs/{org}/actions/variables"],
createRegistrationTokenForOrg: [
"POST /orgs/{org}/actions/runners/registration-token",
],
@@ -43,8 +33,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
createRemoveTokenForRepo: [
"POST /repos/{owner}/{repo}/actions/runners/remove-token",
],
- createRepoVariable: ["POST /repos/{owner}/{repo}/actions/variables"],
- createRequiredWorkflow: ["POST /orgs/{org}/actions/required_workflows"],
createWorkflowDispatch: [
"POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches",
],
@@ -60,20 +48,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
deleteEnvironmentSecret: [
"DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
],
- deleteEnvironmentVariable: [
- "DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}",
- ],
deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"],
- deleteOrgVariable: ["DELETE /orgs/{org}/actions/variables/{name}"],
deleteRepoSecret: [
"DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}",
],
- deleteRepoVariable: [
- "DELETE /repos/{owner}/{repo}/actions/variables/{name}",
- ],
- deleteRequiredWorkflow: [
- "DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}",
- ],
deleteSelfHostedRunnerFromOrg: [
"DELETE /orgs/{org}/actions/runners/{runner_id}",
],
@@ -113,6 +91,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getActionsCacheUsageByRepoForOrg: [
"GET /orgs/{org}/actions/cache/usage-by-repository",
],
+ getActionsCacheUsageForEnterprise: [
+ "GET /enterprises/{enterprise}/actions/cache/usage",
+ ],
getActionsCacheUsageForOrg: ["GET /orgs/{org}/actions/cache/usage"],
getAllowedActionsOrganization: [
"GET /orgs/{org}/actions/permissions/selected-actions",
@@ -127,8 +108,8 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getEnvironmentSecret: [
"GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}",
],
- getEnvironmentVariable: [
- "GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}",
+ getGithubActionsDefaultWorkflowPermissionsEnterprise: [
+ "GET /enterprises/{enterprise}/actions/permissions/workflow",
],
getGithubActionsDefaultWorkflowPermissionsOrganization: [
"GET /orgs/{org}/actions/permissions/workflow",
@@ -145,7 +126,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"],
getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"],
getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"],
- getOrgVariable: ["GET /orgs/{org}/actions/variables/{name}"],
getPendingDeploymentsForRun: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
],
@@ -155,17 +135,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
{ renamed: ["actions", "getGithubActionsPermissionsRepository"] },
],
getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"],
- getRepoRequiredWorkflow: [
- "GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}",
- ],
- getRepoRequiredWorkflowUsage: [
- "GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing",
- ],
getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"],
- getRepoVariable: ["GET /repos/{owner}/{repo}/actions/variables/{name}"],
- getRequiredWorkflow: [
- "GET /orgs/{org}/actions/required_workflows/{required_workflow_id}",
- ],
getReviewsForRun: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals",
],
@@ -191,9 +161,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
listEnvironmentSecrets: [
"GET /repositories/{repository_id}/environments/{environment_name}/secrets",
],
- listEnvironmentVariables: [
- "GET /repositories/{repository_id}/environments/{environment_name}/variables",
- ],
listJobsForWorkflowRun: [
"GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs",
],
@@ -207,17 +174,8 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
"GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
],
listOrgSecrets: ["GET /orgs/{org}/actions/secrets"],
- listOrgVariables: ["GET /orgs/{org}/actions/variables"],
- listRepoRequiredWorkflows: [
- "GET /repos/{org}/{repo}/actions/required_workflows",
- ],
listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"],
- listRepoVariables: ["GET /repos/{owner}/{repo}/actions/variables"],
listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"],
- listRequiredWorkflowRuns: [
- "GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs",
- ],
- listRequiredWorkflows: ["GET /orgs/{org}/actions/required_workflows"],
listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"],
listRunnerApplicationsForRepo: [
"GET /repos/{owner}/{repo}/actions/runners/downloads",
@@ -225,15 +183,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
listSelectedReposForOrgSecret: [
"GET /orgs/{org}/actions/secrets/{secret_name}/repositories",
],
- listSelectedReposForOrgVariable: [
- "GET /orgs/{org}/actions/variables/{name}/repositories",
- ],
listSelectedRepositoriesEnabledGithubActionsOrganization: [
"GET /orgs/{org}/actions/permissions/repositories",
],
- listSelectedRepositoriesRequiredWorkflow: [
- "GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories",
- ],
listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"],
listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"],
listWorkflowRunArtifacts: [
@@ -265,12 +217,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
removeSelectedRepoFromOrgSecret: [
"DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
],
- removeSelectedRepoFromOrgVariable: [
- "DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}",
- ],
- removeSelectedRepoFromRequiredWorkflow: [
- "DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}",
- ],
reviewPendingDeploymentsForRun: [
"POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
],
@@ -286,6 +232,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
setCustomLabelsForSelfHostedRunnerForRepo: [
"PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels",
],
+ setGithubActionsDefaultWorkflowPermissionsEnterprise: [
+ "PUT /enterprises/{enterprise}/actions/permissions/workflow",
+ ],
setGithubActionsDefaultWorkflowPermissionsOrganization: [
"PUT /orgs/{org}/actions/permissions/workflow",
],
@@ -301,28 +250,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
setSelectedReposForOrgSecret: [
"PUT /orgs/{org}/actions/secrets/{secret_name}/repositories",
],
- setSelectedReposForOrgVariable: [
- "PUT /orgs/{org}/actions/variables/{name}/repositories",
- ],
- setSelectedReposToRequiredWorkflow: [
- "PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories",
- ],
setSelectedRepositoriesEnabledGithubActionsOrganization: [
"PUT /orgs/{org}/actions/permissions/repositories",
],
setWorkflowAccessToRepository: [
"PUT /repos/{owner}/{repo}/actions/permissions/access",
],
- updateEnvironmentVariable: [
- "PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}",
- ],
- updateOrgVariable: ["PATCH /orgs/{org}/actions/variables/{name}"],
- updateRepoVariable: [
- "PATCH /repos/{owner}/{repo}/actions/variables/{name}",
- ],
- updateRequiredWorkflow: [
- "PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}",
- ],
},
activity: {
checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"],
@@ -442,6 +375,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getGithubActionsBillingUser: [
"GET /users/{username}/settings/billing/actions",
],
+ getGithubAdvancedSecurityBillingGhe: [
+ "GET /enterprises/{enterprise}/settings/billing/advanced-security",
+ ],
+ getGithubAdvancedSecurityBillingOrg: [
+ "GET /orgs/{org}/settings/billing/advanced-security",
+ ],
getGithubPackagesBillingOrg: ["GET /orgs/{org}/settings/billing/packages"],
getGithubPackagesBillingUser: [
"GET /users/{username}/settings/billing/packages",
@@ -496,6 +435,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
listAlertInstances: [
"GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
],
+ listAlertsForEnterprise: [
+ "GET /enterprises/{enterprise}/code-scanning/alerts",
+ ],
listAlertsForOrg: ["GET /orgs/{org}/code-scanning/alerts"],
listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"],
listAlertsInstances: [
@@ -521,14 +463,14 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
"PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}",
],
addSelectedRepoToOrgSecret: [
- "PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
+ "PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
],
codespaceMachinesForAuthenticatedUser: [
"GET /user/codespaces/{codespace_name}/machines",
],
createForAuthenticatedUser: ["POST /user/codespaces"],
createOrUpdateOrgSecret: [
- "PUT /orgs/{org}/codespaces/secrets/{secret_name}",
+ "PUT /organizations/{org}/codespaces/secrets/{secret_name}",
],
createOrUpdateRepoSecret: [
"PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}",
@@ -546,7 +488,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
deleteFromOrganization: [
"DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}",
],
- deleteOrgSecret: ["DELETE /orgs/{org}/codespaces/secrets/{secret_name}"],
+ deleteOrgSecret: [
+ "DELETE /organizations/{org}/codespaces/secrets/{secret_name}",
+ ],
deleteRepoSecret: [
"DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}",
],
@@ -556,15 +500,12 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
exportForAuthenticatedUser: [
"POST /user/codespaces/{codespace_name}/exports",
],
- getCodespacesForUserInOrg: [
- "GET /orgs/{org}/members/{username}/codespaces",
- ],
getExportDetailsForAuthenticatedUser: [
"GET /user/codespaces/{codespace_name}/exports/{export_id}",
],
getForAuthenticatedUser: ["GET /user/codespaces/{codespace_name}"],
- getOrgPublicKey: ["GET /orgs/{org}/codespaces/secrets/public-key"],
- getOrgSecret: ["GET /orgs/{org}/codespaces/secrets/{secret_name}"],
+ getOrgPublicKey: ["GET /organizations/{org}/codespaces/secrets/public-key"],
+ getOrgSecret: ["GET /organizations/{org}/codespaces/secrets/{secret_name}"],
getPublicKeyForAuthenticatedUser: [
"GET /user/codespaces/secrets/public-key",
],
@@ -589,36 +530,32 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
listInRepositoryForAuthenticatedUser: [
"GET /repos/{owner}/{repo}/codespaces",
],
- listOrgSecrets: ["GET /orgs/{org}/codespaces/secrets"],
+ listOrgSecrets: ["GET /organizations/{org}/codespaces/secrets"],
listRepoSecrets: ["GET /repos/{owner}/{repo}/codespaces/secrets"],
listRepositoriesForSecretForAuthenticatedUser: [
"GET /user/codespaces/secrets/{secret_name}/repositories",
],
listSecretsForAuthenticatedUser: ["GET /user/codespaces/secrets"],
listSelectedReposForOrgSecret: [
- "GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories",
],
preFlightWithRepoForAuthenticatedUser: [
"GET /repos/{owner}/{repo}/codespaces/new",
],
- publishForAuthenticatedUser: [
- "POST /user/codespaces/{codespace_name}/publish",
- ],
removeRepositoryForSecretForAuthenticatedUser: [
"DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}",
],
removeSelectedRepoFromOrgSecret: [
- "DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
+ "DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}",
],
repoMachinesForAuthenticatedUser: [
"GET /repos/{owner}/{repo}/codespaces/machines",
],
- setCodespacesBilling: ["PUT /orgs/{org}/codespaces/billing"],
setRepositoriesForSecretForAuthenticatedUser: [
"PUT /user/codespaces/secrets/{secret_name}/repositories",
],
setSelectedReposForOrgSecret: [
- "PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories",
+ "PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories",
],
startForAuthenticatedUser: ["POST /user/codespaces/{codespace_name}/start"],
stopForAuthenticatedUser: ["POST /user/codespaces/{codespace_name}/stop"],
@@ -650,10 +587,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getRepoSecret: [
"GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}",
],
- listAlertsForEnterprise: [
- "GET /enterprises/{enterprise}/dependabot/alerts",
- ],
- listAlertsForOrg: ["GET /orgs/{org}/dependabot/alerts"],
listAlertsForRepo: ["GET /repos/{owner}/{repo}/dependabot/alerts"],
listOrgSecrets: ["GET /orgs/{org}/dependabot/secrets"],
listRepoSecrets: ["GET /repos/{owner}/{repo}/dependabot/secrets"],
@@ -683,12 +616,45 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
addCustomLabelsToSelfHostedRunnerForEnterprise: [
"POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels",
],
+ disableSelectedOrganizationGithubActionsEnterprise: [
+ "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}",
+ ],
enableSelectedOrganizationGithubActionsEnterprise: [
"PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}",
],
+ getAllowedActionsEnterprise: [
+ "GET /enterprises/{enterprise}/actions/permissions/selected-actions",
+ ],
+ getGithubActionsPermissionsEnterprise: [
+ "GET /enterprises/{enterprise}/actions/permissions",
+ ],
+ getServerStatistics: [
+ "GET /enterprise-installation/{enterprise_or_org}/server-statistics",
+ ],
listLabelsForSelfHostedRunnerForEnterprise: [
"GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels",
],
+ listSelectedOrganizationsEnabledGithubActionsEnterprise: [
+ "GET /enterprises/{enterprise}/actions/permissions/organizations",
+ ],
+ removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: [
+ "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels",
+ ],
+ removeCustomLabelFromSelfHostedRunnerForEnterprise: [
+ "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}",
+ ],
+ setAllowedActionsEnterprise: [
+ "PUT /enterprises/{enterprise}/actions/permissions/selected-actions",
+ ],
+ setCustomLabelsForSelfHostedRunnerForEnterprise: [
+ "PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels",
+ ],
+ setGithubActionsPermissionsEnterprise: [
+ "PUT /enterprises/{enterprise}/actions/permissions",
+ ],
+ setSelectedOrganizationsEnabledGithubActionsEnterprise: [
+ "PUT /enterprises/{enterprise}/actions/permissions/organizations",
+ ],
},
gists: {
checkIsStarred: ["GET /gists/{gist_id}/star"],
@@ -765,9 +731,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"],
checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"],
- checkUserCanBeAssignedToIssue: [
- "GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}",
- ],
create: ["POST /repos/{owner}/{repo}/issues"],
createComment: [
"POST /repos/{owner}/{repo}/issues/{issue_number}/comments",
@@ -839,7 +802,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
},
meta: {
get: ["GET /meta"],
- getAllVersions: ["GET /versions"],
getOctocat: ["GET /octocat"],
getZen: ["GET /zen"],
root: ["GET /"],
@@ -899,8 +861,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
convertMemberToOutsideCollaborator: [
"PUT /orgs/{org}/outside_collaborators/{username}",
],
+ createCustomRole: ["POST /orgs/{org}/custom_roles"],
createInvitation: ["POST /orgs/{org}/invitations"],
createWebhook: ["POST /orgs/{org}/hooks"],
+ deleteCustomRole: ["DELETE /orgs/{org}/custom_roles/{role_id}"],
deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"],
enableOrDisableSecurityProductOnAllOrgRepos: [
"POST /orgs/{org}/{security_product}/{enablement}",
@@ -916,7 +880,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
list: ["GET /organizations"],
listAppInstallations: ["GET /orgs/{org}/installations"],
listBlockedUsers: ["GET /orgs/{org}/blocks"],
+ listCustomRoles: ["GET /organizations/{organization_id}/custom_roles"],
listFailedInvitations: ["GET /orgs/{org}/failed_invitations"],
+ listFineGrainedPermissions: ["GET /orgs/{org}/fine_grained_permissions"],
listForAuthenticatedUser: ["GET /user/orgs"],
listForUser: ["GET /users/{username}/orgs"],
listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"],
@@ -949,6 +915,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
],
unblockUser: ["DELETE /orgs/{org}/blocks/{username}"],
update: ["PATCH /orgs/{org}"],
+ updateCustomRole: ["PATCH /orgs/{org}/custom_roles/{role_id}"],
updateMembershipForAuthenticatedUser: [
"PATCH /user/memberships/orgs/{org}",
],
@@ -1571,9 +1538,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
getAlert: [
"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
],
- getSecurityAnalysisSettingsForEnterprise: [
- "GET /enterprises/{enterprise}/code_security_and_analysis",
- ],
listAlertsForEnterprise: [
"GET /enterprises/{enterprise}/secret-scanning/alerts",
],
@@ -1582,12 +1546,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = {
listLocationsForAlert: [
"GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations",
],
- patchSecurityAnalysisSettingsForEnterprise: [
- "PATCH /enterprises/{enterprise}/code_security_and_analysis",
- ],
- postSecurityProductEnablementForEnterprise: [
- "POST /enterprises/{enterprise}/{security_product}/{enablement}",
- ],
updateAlert: [
"PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}",
],
diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts
index bec79d00b..df48df05f 100644
--- a/src/generated/method-types.ts
+++ b/src/generated/method-types.ts
@@ -44,34 +44,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- */
- addSelectedRepoToOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["addSelectedRepoToOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- addSelectedRepoToRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["addSelectedRepoToRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)."
*
@@ -98,20 +70,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Create an environment variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- */
- createEnvironmentVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["createEnvironmentVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["createEnvironmentVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Creates or updates an environment secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
@@ -120,29 +78,28 @@ export type RestEndpointMethods = {
*
* #### Example encrypting a secret using Node.js
*
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * const sodium = require('tweetsodium');
*
- * //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
*
- * console.log(output)
- * });
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
* ```
*
+ *
* #### Example encrypting a secret using Python
*
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
@@ -293,29 +250,28 @@ export type RestEndpointMethods = {
*
* #### Example encrypting a secret using Node.js
*
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * const sodium = require('tweetsodium');
*
- * //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
*
- * console.log(output)
- * });
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
* ```
*
+ *
* #### Example encrypting a secret using Python
*
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
@@ -372,20 +328,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Creates an organization variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- */
- createOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["createOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["createOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Returns a token that you can pass to the `config` script. The token expires after one hour.
*
@@ -473,36 +415,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Creates a repository variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
- */
- createRepoVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["createRepoVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["createRepoVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Create a required workflow in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- createRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["createRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
*
@@ -575,20 +487,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Deletes an environment variable using the variable name.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- */
- deleteEnvironmentVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["deleteEnvironmentVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["deleteEnvironmentVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.
*/
@@ -601,20 +499,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Deletes an organization variable using the variable name.
- * 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.
- */
- deleteOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["deleteOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["deleteOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
*/
@@ -627,36 +511,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Deletes a repository variable using the variable name.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
- */
- deleteRepoVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["deleteRepoVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["deleteRepoVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Deletes a required workflow configured in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- deleteRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["deleteRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
*
@@ -870,6 +724,20 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Gets the total GitHub Actions cache usage for an enterprise.
+ * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ getActionsCacheUsageForEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["actions"]["getActionsCacheUsageForEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Gets the total GitHub Actions cache usage for an organization.
* The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.
@@ -947,13 +815,18 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Gets a specific variable in an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.
+ * Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,
+ * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see
+ * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#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.
+ * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
*/
- getEnvironmentVariable: {
+ getGithubActionsDefaultWorkflowPermissionsEnterprise: {
(
- params?: RestEndpointMethodTypes["actions"]["getEnvironmentVariable"]["parameters"]
+ params?: RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsEnterprise"]["parameters"]
): Promise<
- RestEndpointMethodTypes["actions"]["getEnvironmentVariable"]["response"]
+ RestEndpointMethodTypes["actions"]["getGithubActionsDefaultWorkflowPermissionsEnterprise"]["response"]
>;
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
@@ -1054,18 +927,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Gets a specific variable in an organization. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
- */
- getOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["getOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["getOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Get all deployment environments for a workflow run that are waiting for protection rules to pass.
*
@@ -1107,34 +968,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Gets a specific required workflow present in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- getRepoRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Gets the number of billable minutes used by a specific required workflow during the current billing cycle.
- *
- * Billable minutes only apply to required workflows running in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)."
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
- */
- getRepoRequiredWorkflowUsage: {
- (
- params?: RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["getRepoRequiredWorkflowUsage"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
*/
@@ -1147,34 +980,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Gets a specific variable in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
- */
- getRepoVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["getRepoVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["getRepoVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Get a required workflow configured in an organization.
- *
- * You must authenticate using an access token with the `read:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- getRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["getRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
*/
@@ -1228,8 +1033,7 @@ export type RestEndpointMethods = {
};
/**
* Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to private repositories.
- * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)."
+ * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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 endpoint.
@@ -1322,18 +1126,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists all environment variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environments:read` repository permission to use this endpoint.
- */
- listEnvironmentVariables: {
- (
- params?: RestEndpointMethodTypes["actions"]["listEnvironmentVariables"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listEnvironmentVariables"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
*/
@@ -1399,30 +1191,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists all organization variables. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
- */
- listOrgVariables: {
- (
- params?: RestEndpointMethodTypes["actions"]["listOrgVariables"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listOrgVariables"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Lists the required workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- listRepoRequiredWorkflows: {
- (
- params?: RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listRepoRequiredWorkflows"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.
*/
@@ -1435,18 +1203,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists all repository variables. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.
- */
- listRepoVariables: {
- (
- params?: RestEndpointMethodTypes["actions"]["listRepoVariables"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listRepoVariables"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.
*/
@@ -1459,36 +1215,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * List all workflow runs for a required workflow. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).
- *
- * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- listRequiredWorkflowRuns: {
- (
- params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listRequiredWorkflowRuns"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * List all required workflows in an organization.
- *
- * You must authenticate using an access token with the `read:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- listRequiredWorkflows: {
- (
- params?: RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listRequiredWorkflows"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists binaries for the runner application that you can download and run.
*
@@ -1529,18 +1255,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists all repositories that can access an organization variable that is available to selected repositories. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint.
- */
- listSelectedReposForOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["listSelectedReposForOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listSelectedReposForOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
@@ -1555,22 +1269,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists the selected repositories that are configured for a required workflow in an organization. To use this endpoint, the required workflow must be configured to run on selected repositories.
- *
- * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- listSelectedRepositoriesRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["listSelectedRepositoriesRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists all self-hosted runners configured in an organization.
*
@@ -1753,34 +1451,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- */
- removeSelectedRepoFromOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["removeSelectedRepoFromOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Removes a repository from a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- removeSelectedRepoFromRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["removeSelectedRepoFromRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Approve or reject pending deployments that are waiting on approval by a required reviewer.
*
@@ -1862,6 +1532,23 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets
+ * whether GitHub Actions can submit approving pull request reviews. For more information, see
+ * "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#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.
+ * GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.
+ */
+ setGithubActionsDefaultWorkflowPermissionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["actions"]["setGithubActionsDefaultWorkflowPermissionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions
* can submit approving pull request reviews. For more information, see
@@ -1938,34 +1625,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- */
- setSelectedReposForOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["setSelectedReposForOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["setSelectedReposForOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Sets the repositories for a required workflow that is required for selected repositories.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- setSelectedReposToRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["setSelectedReposToRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."
*
@@ -1982,8 +1641,7 @@ export type RestEndpointMethods = {
};
/**
* Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.
- * This endpoint only applies to private repositories.
- * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)".
+ * This endpoint only applies to internal repositories. For more information, see "[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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 endpoint.
@@ -1997,64 +1655,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Updates an environment variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `environment:write` repository permission to use this endpoint.
- */
- updateEnvironmentVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["updateEnvironmentVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["updateEnvironmentVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Updates an organization variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint.
- */
- updateOrgVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["updateOrgVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["updateOrgVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Updates a repository variable that you can reference in a GitHub Actions workflow.
- * You must authenticate using an access token with the `repo` scope to use this endpoint.
- * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.
- */
- updateRepoVariable: {
- (
- params?: RestEndpointMethodTypes["actions"]["updateRepoVariable"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["updateRepoVariable"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Update a required workflow in an organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- *
- * For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)."
- */
- updateRequiredWorkflow: {
- (
- params?: RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["actions"]["updateRequiredWorkflow"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
};
activity: {
checkRepoIsStarredByAuthenticatedUser: {
@@ -2120,9 +1720,7 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Gets information about a notification thread.
- */
+
getThread: {
(
params?: RestEndpointMethodTypes["activity"]["getThread"]["parameters"]
@@ -2255,7 +1853,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Lists all notifications for the current user in the specified repository.
+ * List all notifications for the current user.
*/
listRepoNotificationsForAuthenticatedUser: {
(
@@ -2345,7 +1943,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ * Marks all notifications as "read" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
*/
markNotificationsAsRead: {
(
@@ -2357,7 +1955,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
+ * Marks all notifications in a repository as "read" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.
*/
markRepoNotificationsAsRead: {
(
@@ -2368,9 +1966,7 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications.
- */
+
markThreadAsRead: {
(
params?: RestEndpointMethodTypes["activity"]["markThreadAsRead"]["parameters"]
@@ -2983,6 +2579,40 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Gets the GitHub Advanced Security active committers for an enterprise per repository.
+ *
+ * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository.
+ *
+ * The total number of repositories with committer information is tracked by the `total_count` field.
+ */
+ getGithubAdvancedSecurityBillingGhe: {
+ (
+ params?: RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingGhe"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingGhe"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Gets the GitHub Advanced Security active committers for an organization per repository.
+ *
+ * Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository.
+ *
+ * If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.
+ *
+ * The total number of repositories with committer information is tracked by the `total_count` field.
+ */
+ getGithubAdvancedSecurityBillingOrg: {
+ (
+ params?: RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingOrg"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["billing"]["getGithubAdvancedSecurityBillingOrg"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Gets the free and paid storage used for GitHub Packages in gigabytes.
*
@@ -3279,6 +2909,9 @@ export type RestEndpointMethods = {
};
/**
* Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint.
+ *
+ * **Deprecation notice**:
+ * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.
*/
getAlert: {
(
@@ -3368,6 +3001,21 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
+ *
+ * To 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.
+ */
+ listAlertsForEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["codeScanning"]["listAlertsForEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["codeScanning"]["listAlertsForEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
*
@@ -3491,24 +3139,11 @@ export type RestEndpointMethods = {
* ```
* gzip -c analysis-data.sarif | base64 -w0
* ```
- *
- * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.
- * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration (For example, for the CodeQL tool, identify and remove the most noisy queries).
*
+ * SARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.
*
- * | **SARIF data** | **Maximum values** | **Additional limits** |
- * |----------------------------------|:------------------:|----------------------------------------------------------------------------------|
- * | Runs per file | 15 | |
- * | Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
- * | Rules per run | 25,000 | |
- * | Tool extensions per run | 100 | |
- * | Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
- * | Location per result | 1,000 | Only 100 locations will be included. |
- * | Tags per rule | 20 | Only 10 tags will be included. |
- *
- *
- * The `202 Accepted` response includes an `id` value.
- * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
+ * The `202 Accepted`, response includes an `id` value.
+ * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.
* For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)."
*/
uploadSarif: {
@@ -3613,23 +3248,26 @@ export type RestEndpointMethods = {
* Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * // Written with ❤️ by PSJ and free to use under The Unlicense.
+ * const sodium=require('libsodium-wrappers')
+ * const secret = 'plain-text-secret' // replace with secret before running the script.
+ * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key.
*
* //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * sodium.ready.then( ()=>{
+ *
+ * // Convert Secret & Base64 key to Uint8Array.
+ * let binkey= sodium.from_base64(key, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(key, 'base64')
+ * let binsec= sodium.from_string(secret) // Equivalent of Buffer.from(secret)
+ *
+ * //Encrypt the secret using LibSodium
+ * let encBytes= sodium.crypto_box_seal(binsec,binkey) // Similar to tweetsodium.seal(binsec,binkey)
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Convert encrypted Uint8Array to Base64
+ * let output=sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL) //Equivalent of Buffer.from(encBytes).toString('base64')
*
- * console.log(output)
+ * console.log(output)
* });
* ```
*
@@ -3692,34 +3330,33 @@ export type RestEndpointMethods = {
/**
* Creates or updates a repository secret with an encrypted value. Encrypt your secret using
* [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access
- * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets`
- * repository permission to use this endpoint.
+ * token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository
+ * permission to use this endpoint.
*
* #### Example of encrypting a secret using Node.js
*
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * const sodium = require('tweetsodium');
*
- * //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
*
- * console.log(output)
- * });
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
* ```
*
+ *
* #### Example of encrypting a secret using Python
*
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
@@ -3782,33 +3419,32 @@ export type RestEndpointMethods = {
*
* You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint.
*
- * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
+ * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint.
*
* #### Example encrypting a secret using Node.js
*
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * const sodium = require('tweetsodium');
*
- * //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
+ *
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
*
- * console.log(output)
- * });
+ * console.log(encrypted);
* ```
*
+ *
* #### Example encrypting a secret using Python
*
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
@@ -3940,7 +3576,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
*/
deleteRepoSecret: {
(
@@ -3970,8 +3606,6 @@ export type RestEndpointMethods = {
/**
* Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored.
*
- * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead.
- *
* You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
*
* GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint.
@@ -3985,20 +3619,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Lists the codespaces that a member of an organization has for repositories in that organization.
- *
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- getCodespacesForUserInOrg: {
- (
- params?: RestEndpointMethodTypes["codespaces"]["getCodespacesForUserInOrg"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["codespaces"]["getCodespacesForUserInOrg"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Gets information about an export of a codespace.
*
@@ -4073,7 +3693,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
*/
getRepoPublicKey: {
(
@@ -4085,7 +3705,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
*/
getRepoSecret: {
(
@@ -4189,7 +3809,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint.
+ * Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `codespaces_secrets` repository permission to use this endpoint.
*/
listRepoSecrets: {
(
@@ -4261,26 +3881,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Publishes an unpublished codespace, creating a new repository and assigning it to the codespace.
- *
- * The codespace's token is granted write permissions to the repository, allowing the user to push their changes.
- *
- * This will fail for a codespace that is already published, meaning it has an associated repository.
- *
- * You must authenticate using a personal access token with the `codespace` scope to use this endpoint.
- *
- * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.
- */
- publishForAuthenticatedUser: {
- (
- params?: RestEndpointMethodTypes["codespaces"]["publishForAuthenticatedUser"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["codespaces"]["publishForAuthenticatedUser"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Removes a repository from the selected repositories for a user's codespace secret.
* You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint.
@@ -4323,19 +3923,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.
- * You must authenticate using an access token with the `admin:org` scope to use this endpoint.
- */
- setCodespacesBilling: {
- (
- params?: RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["codespaces"]["setCodespacesBilling"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Select the repositories that will use a user's codespace secret.
*
@@ -4536,29 +4123,28 @@ export type RestEndpointMethods = {
*
* #### Example encrypting a secret using Node.js
*
- * Encrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.
+ * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.
*
* ```
- * const sodium = require('libsodium-wrappers')
- * const secret = 'plain-text-secret' // replace with the secret you want to encrypt
- * const key = 'base64-encoded-public-key' // replace with the Base64 encoded public key
+ * const sodium = require('tweetsodium');
*
- * //Check if libsodium is ready and then proceed.
- * sodium.ready.then(() => {
- * // Convert Secret & Base64 key to Uint8Array.
- * let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)
- * let binsec = sodium.from_string(secret)
+ * const key = "base64-encoded-public-key";
+ * const value = "plain-text-secret";
*
- * //Encrypt the secret using LibSodium
- * let encBytes = sodium.crypto_box_seal(binsec, binkey)
+ * // Convert the message and key to Uint8Array's (Buffer implements that interface)
+ * const messageBytes = Buffer.from(value);
+ * const keyBytes = Buffer.from(key, 'base64');
*
- * // Convert encrypted Uint8Array to Base64
- * let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)
+ * // Encrypt using LibSodium.
+ * const encryptedBytes = sodium.seal(messageBytes, keyBytes);
*
- * console.log(output)
- * });
+ * // Base64 the encrypted secret
+ * const encrypted = Buffer.from(encryptedBytes).toString('base64');
+ *
+ * console.log(encrypted);
* ```
*
+ *
* #### Example encrypting a secret using Python
*
* Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
@@ -4690,44 +4276,11 @@ export type RestEndpointMethods = {
/**
* Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
*/
- getRepoSecret: {
- (
- params?: RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Lists Dependabot alerts for repositories that are owned by the specified enterprise.
- * To 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. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
- */
- listAlertsForEnterprise: {
- (
- params?: RestEndpointMethodTypes["dependabot"]["listAlertsForEnterprise"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["dependabot"]["listAlertsForEnterprise"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Lists Dependabot alerts for an organization.
- *
- * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
- *
- * For public repositories, you may instead use the `public_repo` scope.
- *
- * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
- */
- listAlertsForOrg: {
+ getRepoSecret: {
(
- params?: RestEndpointMethodTypes["dependabot"]["listAlertsForOrg"]["parameters"]
+ params?: RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["parameters"]
): Promise<
- RestEndpointMethodTypes["dependabot"]["listAlertsForOrg"]["response"]
+ RestEndpointMethodTypes["dependabot"]["getRepoSecret"]["response"]
>;
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
@@ -4874,6 +4427,20 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ disableSelectedOrganizationGithubActionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["disableSelectedOrganizationGithubActionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["disableSelectedOrganizationGithubActionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
*
@@ -4888,6 +4455,54 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Gets the selected actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ getAllowedActionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["getAllowedActionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["getAllowedActionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ getGithubActionsPermissionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["getGithubActionsPermissionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["getGithubActionsPermissionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Returns aggregate usage metrics for your GitHub Enterprise Server 3.5+ instance for a specified time period up to 365 days.
+ *
+ * To use this endpoint, your GitHub Enterprise Server instance must be connected to GitHub Enterprise Cloud using GitHub Connect. You must enable Server Statistics, and for the API request provide your enterprise account name or organization name connected to the GitHub Enterprise Server. For more information, see "[Enabling Server Statistics for your enterprise](/admin/configuration/configuring-github-connect/enabling-server-statistics-for-your-enterprise)" in the GitHub Enterprise Server documentation.
+ *
+ * You'll need to use a personal access token:
+ * - If you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics, you'll need a personal access token with the `read:enterprise` permission.
+ * - If you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics, you'll need a personal access token with the `read:org` permission.
+ *
+ * For more information on creating a personal access token, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
+ */
+ getServerStatistics: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["getServerStatistics"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["getServerStatistics"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Lists all labels for a self-hosted runner configured in an enterprise.
*
@@ -4902,6 +4517,110 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ listSelectedOrganizationsEnabledGithubActionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["listSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["listSelectedOrganizationsEnabledGithubActionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Remove all custom labels from a self-hosted runner configured in an
+ * enterprise. Returns the remaining read-only labels from the runner.
+ *
+ * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ */
+ removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["removeAllCustomLabelsFromSelfHostedRunnerForEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["removeAllCustomLabelsFromSelfHostedRunnerForEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Remove a custom label from a self-hosted runner configured
+ * in an enterprise. Returns the remaining labels from the runner.
+ *
+ * This endpoint returns a `404 Not Found` status if the custom label is not
+ * present on the runner.
+ *
+ * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ */
+ removeCustomLabelFromSelfHostedRunnerForEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["removeCustomLabelFromSelfHostedRunnerForEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["removeCustomLabelFromSelfHostedRunnerForEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Sets the actions and reusable workflows that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ setAllowedActionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["setAllowedActionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["setAllowedActionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Remove all previous custom labels and set the new custom labels for a specific
+ * self-hosted runner configured in an enterprise.
+ *
+ * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.
+ */
+ setCustomLabelsForSelfHostedRunnerForEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["setCustomLabelsForSelfHostedRunnerForEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["setCustomLabelsForSelfHostedRunnerForEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ setGithubActionsPermissionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["setGithubActionsPermissionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["setGithubActionsPermissionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
+ /**
+ * Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)."
+ *
+ * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.
+ */
+ setSelectedOrganizationsEnabledGithubActionsEnterprise: {
+ (
+ params?: RestEndpointMethodTypes["enterpriseAdmin"]["setSelectedOrganizationsEnabledGithubActionsEnterprise"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["enterpriseAdmin"]["setSelectedOrganizationsEnabledGithubActionsEnterprise"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
};
gists: {
checkIsStarred: {
@@ -5066,7 +4785,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
*/
update: {
(
@@ -5555,22 +5274,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Checks if a user has permission to be assigned to a specific issue.
- *
- * If the `assignee` can be assigned to this issue, a `204` status code with no content is returned.
- *
- * Otherwise a `404` status code is returned.
- */
- checkUserCanBeAssignedToIssue: {
- (
- params?: RestEndpointMethodTypes["issues"]["checkUserCanBeAssignedToIssue"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["issues"]["checkUserCanBeAssignedToIssue"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.
*
@@ -5649,7 +5352,7 @@ export type RestEndpointMethods = {
* access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
* to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
*
- * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
@@ -5699,7 +5402,7 @@ export type RestEndpointMethods = {
* necessarily assigned to you.
*
*
- * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
@@ -5776,7 +5479,7 @@ export type RestEndpointMethods = {
/**
* List issues across owned and member repositories assigned to the authenticated user.
*
- * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
@@ -5793,7 +5496,7 @@ export type RestEndpointMethods = {
/**
* List issues in an organization assigned to the authenticated user.
*
- * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
@@ -5806,9 +5509,9 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * List issues in a repository. Only open issues will be listed.
+ * List issues in a repository.
*
- * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
+ * **Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
* reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
* the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull
* request id, use the "[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)" endpoint.
@@ -6026,16 +5729,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Get all supported GitHub API versions.
- */
- getAllVersions: {
- (
- params?: RestEndpointMethodTypes["meta"]["getAllVersions"]["parameters"]
- ): Promise;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Get the octocat as ASCII art
*/
@@ -6448,7 +6141,7 @@ export type RestEndpointMethods = {
/**
* Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications).
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications).
*/
cancelInvitation: {
(
@@ -6492,7 +6185,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ * When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
*/
convertMemberToOutsideCollaborator: {
(
@@ -6503,10 +6196,29 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * **Note**: This operation is in beta and is subject to change.
+ *
+ * Creates a custom repository role that can be used by all repositories owned by the organization.
+ *
+ * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
+ * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
+ *
+ * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ */
+ createCustomRole: {
+ (
+ params?: RestEndpointMethodTypes["orgs"]["createCustomRole"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["orgs"]["createCustomRole"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*/
createInvitation: {
(
@@ -6527,6 +6239,26 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * **Note**: This operation is in beta and is subject to change.
+ *
+ * Deletes a custom role from an organization. Once the custom role has been deleted, any
+ * user, team, or invitation with the deleted custom role will be reassigned the inherited role.
+ *
+ * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
+ * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
+ *
+ * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ */
+ deleteCustomRole: {
+ (
+ params?: RestEndpointMethodTypes["orgs"]["deleteCustomRole"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["orgs"]["deleteCustomRole"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
deleteWebhook: {
(
@@ -6660,6 +6392,24 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * List the custom repository roles available in this organization. In order to see custom
+ * repository roles in an organization, the authenticated user must be an organization owner.
+ *
+ * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
+ * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
+ *
+ * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".
+ */
+ listCustomRoles: {
+ (
+ params?: RestEndpointMethodTypes["orgs"]["listCustomRoles"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["orgs"]["listCustomRoles"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure.
*/
@@ -6672,6 +6422,23 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * **Note**: This operation is in beta and subject to change.
+ *
+ * Lists the fine-grained permissions available for an organization.
+ *
+ * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.
+ * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.
+ */
+ listFineGrainedPermissions: {
+ (
+ params?: RestEndpointMethodTypes["orgs"]["listFineGrainedPermissions"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["orgs"]["listFineGrainedPermissions"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
/**
* List organizations for the authenticated user.
*
@@ -6942,6 +6709,25 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
+ /**
+ * **Note**: This operation is in beta and subject to change.
+ *
+ * Updates a custom repository role that can be used by all repositories owned by the organization.
+ *
+ * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.
+ * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.
+ *
+ * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)."
+ */
+ updateCustomRole: {
+ (
+ params?: RestEndpointMethodTypes["orgs"]["updateCustomRole"]["parameters"]
+ ): Promise<
+ RestEndpointMethodTypes["orgs"]["updateCustomRole"]["response"]
+ >;
+ defaults: RequestInterface["defaults"];
+ endpoint: EndpointInterface<{ url: string }>;
+ };
updateMembershipForAuthenticatedUser: {
(
@@ -6981,8 +6767,8 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
deletePackageForAuthenticatedUser: {
(
@@ -6996,9 +6782,9 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To 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:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
*/
deletePackageForOrg: {
(
@@ -7012,9 +6798,9 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
*/
deletePackageForUser: {
(
@@ -7028,8 +6814,8 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To 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.
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
deletePackageVersionForAuthenticatedUser: {
(
@@ -7043,9 +6829,9 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To 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:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
*/
deletePackageVersionForOrg: {
(
@@ -7059,9 +6845,9 @@ export type RestEndpointMethods = {
/**
* 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.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container you want to delete.
*/
deletePackageVersionForUser: {
(
@@ -7075,7 +6861,8 @@ export type RestEndpointMethods = {
/**
* Lists package versions for a package owned by an organization.
*
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
* @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByAnOrg() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByOrg() (2021-03-24)
*/
getAllPackageVersionsForAPackageOwnedByAnOrg: {
@@ -7090,7 +6877,8 @@ export type RestEndpointMethods = {
/**
* Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
* @deprecated octokit.rest.packages.getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser() has been renamed to octokit.rest.packages.getAllPackageVersionsForPackageOwnedByAuthenticatedUser() (2021-03-24)
*/
getAllPackageVersionsForAPackageOwnedByTheAuthenticatedUser: {
@@ -7105,7 +6893,8 @@ export type RestEndpointMethods = {
/**
* Lists package versions for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getAllPackageVersionsForPackageOwnedByAuthenticatedUser: {
(
@@ -7119,7 +6908,8 @@ export type RestEndpointMethods = {
/**
* Lists package versions for a package owned by an organization.
*
- * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getAllPackageVersionsForPackageOwnedByOrg: {
(
@@ -7133,7 +6923,8 @@ export type RestEndpointMethods = {
/**
* Lists package versions for a public package owned by a specified user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getAllPackageVersionsForPackageOwnedByUser: {
(
@@ -7147,7 +6938,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageForAuthenticatedUser: {
(
@@ -7161,7 +6953,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package in an organization.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageForOrganization: {
(
@@ -7175,7 +6968,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package metadata for a public package owned by a user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageForUser: {
(
@@ -7189,7 +6983,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package version for a package owned by the authenticated user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageVersionForAuthenticatedUser: {
(
@@ -7203,7 +6998,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package version in an organization.
*
- * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * You must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageVersionForOrganization: {
(
@@ -7217,7 +7013,8 @@ export type RestEndpointMethods = {
/**
* Gets a specific package version for a public package owned by a specified user.
*
- * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * At this time, to use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
getPackageVersionForUser: {
(
@@ -7231,7 +7028,8 @@ export type RestEndpointMethods = {
/**
* Lists packages owned by the authenticated user within the user's namespace.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
listPackagesForAuthenticatedUser: {
(
@@ -7245,7 +7043,8 @@ export type RestEndpointMethods = {
/**
* Lists all packages in an organization readable by the user.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
listPackagesForOrganization: {
(
@@ -7259,7 +7058,8 @@ export type RestEndpointMethods = {
/**
* Lists all packages in a user's namespace for which the requesting user has access.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` scope.
+ * If `package_type` is not `container`, your token must also include the `repo` scope.
*/
listPackagesForUser: {
(
@@ -7277,7 +7077,7 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
*/
restorePackageForAuthenticatedUser: {
(
@@ -7295,9 +7095,9 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To 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:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
*/
restorePackageForOrg: {
(
@@ -7315,9 +7115,9 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
*/
restorePackageForUser: {
(
@@ -7335,7 +7135,7 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope.
*/
restorePackageVersionForAuthenticatedUser: {
(
@@ -7353,9 +7153,9 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To 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:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
*/
restorePackageVersionForOrg: {
(
@@ -7373,9 +7173,9 @@ export type RestEndpointMethods = {
* - The package was deleted within the last 30 days.
* - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
*
- * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition:
- * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."
- * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
+ * To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition:
+ * - If `package_type` is not `container`, your token must also include the `repo` scope.
+ * - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore.
*/
restorePackageVersionForUser: {
(
@@ -7652,7 +7452,7 @@ export type RestEndpointMethods = {
*
* To 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.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details.
*/
create: {
(
@@ -7664,7 +7464,7 @@ export type RestEndpointMethods = {
/**
* 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](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*/
createReplyForReviewComment: {
(
@@ -7676,11 +7476,11 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*
* Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request)."
*
- * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.
+ * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.
*
* 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.
*/
@@ -7698,7 +7498,7 @@ export type RestEndpointMethods = {
*
* **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.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*/
createReviewComment: {
(
@@ -8277,6 +8077,10 @@ export type RestEndpointMethods = {
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Grants 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.
+ *
+ * | Type | Description |
+ * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
addAppAccessRestrictions: {
(
@@ -8290,7 +8094,7 @@ export type RestEndpointMethods = {
/**
* This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*
- * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
+ * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)."
*
* For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:
*
@@ -8386,7 +8190,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ * Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
*/
checkVulnerabilityAlerts: {
(
@@ -8465,26 +8269,21 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * 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](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)."
+ * The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.
*
- * This 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](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) 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.
+ * The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
*
- * 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.
+ * The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
*
* **Working with large comparisons**
*
- * To process a response with a large number of commits, use a query parameter (`per_page` or `page`) to paginate the results. When using pagination:
- *
- * - The list of changed files is only shown on the first page of results, but it includes all changed files for the entire comparison.
- * - The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
+ * To process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see "[Traversing with pagination](/rest/guides/traversing-with-pagination)."
*
- * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api)."
+ * When calling this API without any paging parameters (`per_page` or `page`), the returned list is limited to 250 commits and the last commit in the list is the most recent of the entire comparison. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.
*
* **Signature verification object**
*
- * The response will include a `verification` object that describes the result of verifying the commit's signature. The `verification` object includes the following fields:
+ * The 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 |
* | ---- | ---- | ----------- |
@@ -8535,7 +8334,7 @@ export type RestEndpointMethods = {
/**
* Create a comment for a commit using its `:commit_sha`.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*/
createCommitComment: {
(
@@ -8787,8 +8586,6 @@ export type RestEndpointMethods = {
};
/**
* Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
- *
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
*/
createPagesSite: {
(
@@ -8802,7 +8599,7 @@ export type RestEndpointMethods = {
/**
* Users with push access to the repository can create a release.
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*/
createRelease: {
(
@@ -8999,7 +8796,7 @@ export type RestEndpointMethods = {
* * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
* * Mark the active deployment as inactive by adding any non-successful deployment status.
*
- * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/deployment-statuses#create-a-deployment-status)."
+ * For more information, see "[Create a deployment](https://docs.github.com/rest/reference/repos/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/reference/repos#create-a-deployment-status)."
*/
deleteDeployment: {
(
@@ -9052,11 +8849,7 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Deletes a a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
- *
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
- */
+
deletePagesSite: {
(
params?: RestEndpointMethodTypes["repos"]["deletePagesSite"]["parameters"]
@@ -9120,7 +8913,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ * Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)".
*/
disableAutomatedSecurityFixes: {
(
@@ -9131,9 +8924,7 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.
- */
+
disableLfsForRepo: {
(
params?: RestEndpointMethodTypes["repos"]["disableLfsForRepo"]["parameters"]
@@ -9144,7 +8935,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ * Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
*/
disableVulnerabilityAlerts: {
(
@@ -9157,7 +8948,7 @@ export type RestEndpointMethods = {
};
/**
* Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
*
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
@@ -9174,7 +8965,7 @@ export type RestEndpointMethods = {
};
/**
* Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
* **Note**: For private repositories, these links are temporary and expire after five minutes.
*/
@@ -9189,7 +8980,7 @@ export type RestEndpointMethods = {
};
/**
* Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually
- * `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
+ * `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use
* the `Location` header to make a second `GET` request.
*
* **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.
@@ -9204,7 +8995,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)".
+ * Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/en/articles/configuring-automated-security-fixes)".
*/
enableAutomatedSecurityFixes: {
(
@@ -9215,9 +9006,7 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.
- */
+
enableLfsForRepo: {
(
params?: RestEndpointMethodTypes["repos"]["enableLfsForRepo"]["parameters"]
@@ -9228,7 +9017,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)".
+ * Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)".
*/
enableVulnerabilityAlerts: {
(
@@ -9253,8 +9042,6 @@ export type RestEndpointMethods = {
};
/**
* 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
*/
get: {
(params?: RestEndpointMethodTypes["repos"]["get"]["parameters"]): Promise<
@@ -9508,7 +9295,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Returns all community profile metrics for a repository. The repository cannot be a fork.
+ * Returns all community profile metrics for a repository. The repository must be public, and cannot be a fork.
*
* The returned metrics include an overall health score, the repository description, the presence of documentation, the
* detected code of conduct, the detected license, and the presence of ISSUE\_TEMPLATE, PULL\_REQUEST\_TEMPLATE,
@@ -9697,7 +9484,7 @@ export type RestEndpointMethods = {
*
* The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.
*
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
+ * Users must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.
*/
getPagesHealthCheck: {
(
@@ -10051,7 +9838,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.
+ * Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.
*
* GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.
*/
@@ -10128,8 +9915,6 @@ export type RestEndpointMethods = {
};
/**
* Lists repositories for the specified organization.
- *
- * **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
*/
listForOrg: {
(
@@ -10215,7 +10000,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.
+ * Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.
*/
listPullRequestsAssociatedWithCommit: {
(
@@ -10344,6 +10129,10 @@ export type RestEndpointMethods = {
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Removes 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.
+ *
+ * | Type | Description |
+ * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
removeAppAccessRestrictions: {
(
@@ -10490,6 +10279,10 @@ export type RestEndpointMethods = {
* Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
* Replaces 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.
+ *
+ * | Type | Description |
+ * | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+ * | `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |
*/
setAppAccessRestrictions: {
(
@@ -10626,8 +10419,6 @@ export type RestEndpointMethods = {
};
/**
* Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
- *
- * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions.
*/
updateInformationAboutPagesSite: {
(
@@ -10798,7 +10589,7 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
+ * Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).
*
* When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match
* metadata](https://docs.github.com/rest/reference/search#text-match-metadata).
@@ -10927,19 +10718,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Gets code security and analysis settings for the specified enterprise.
- * To use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.
- */
- getSecurityAnalysisSettingsForEnterprise: {
- (
- params?: RestEndpointMethodTypes["secretScanning"]["getSecurityAnalysisSettingsForEnterprise"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["secretScanning"]["getSecurityAnalysisSettingsForEnterprise"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
* To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).
@@ -11001,33 +10779,6 @@ export type RestEndpointMethods = {
defaults: RequestInterface["defaults"];
endpoint: EndpointInterface<{ url: string }>;
};
- /**
- * Updates the settings for advanced security, secret scanning, and push protection for new repositories in an enterprise.
- * To use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.
- */
- patchSecurityAnalysisSettingsForEnterprise: {
- (
- params?: RestEndpointMethodTypes["secretScanning"]["patchSecurityAnalysisSettingsForEnterprise"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["secretScanning"]["patchSecurityAnalysisSettingsForEnterprise"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
- /**
- * Enables or disables the specified security feature for all repositories in an enterprise.
- *
- * To use this endpoint, you must be an administrator of the enterprise, and you must use an access token with the `admin:enterprise` scope.
- */
- postSecurityProductEnablementForEnterprise: {
- (
- params?: RestEndpointMethodTypes["secretScanning"]["postSecurityProductEnablementForEnterprise"]["parameters"]
- ): Promise<
- RestEndpointMethodTypes["secretScanning"]["postSecurityProductEnablementForEnterprise"]["response"]
- >;
- defaults: RequestInterface["defaults"];
- endpoint: EndpointInterface<{ url: string }>;
- };
/**
* Updates the status of a secret scanning alert in an eligible repository.
* To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.
@@ -11047,10 +10798,10 @@ export type RestEndpointMethods = {
};
teams: {
/**
- * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
- *
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
+ * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
+ *
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
* An 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.
@@ -11087,7 +10838,7 @@ export type RestEndpointMethods = {
*
* **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](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
+ * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".
*/
addOrUpdateRepoPermissionsInOrg: {
(
@@ -11131,9 +10882,9 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)."
+ * To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization)."
*
- * 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](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
+ * 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](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)".
*/
create: {
(
@@ -11145,7 +10896,7 @@ export type RestEndpointMethods = {
/**
* Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*
* **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`.
*/
@@ -11161,7 +10912,7 @@ export type RestEndpointMethods = {
/**
* Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).
*
- * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
+ * This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details.
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.
*/
@@ -11398,10 +11149,10 @@ export type RestEndpointMethods = {
endpoint: EndpointInterface<{ url: string }>;
};
/**
- * 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.
- *
* Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
*
+ * 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.
+ *
* **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
*
* **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.
diff --git a/src/generated/parameters-and-response-types.ts b/src/generated/parameters-and-response-types.ts
index 22881fe54..063b0e9fe 100644
--- a/src/generated/parameters-and-response-types.ts
+++ b/src/generated/parameters-and-response-types.ts
@@ -26,22 +26,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"];
};
- addSelectedRepoToOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["response"];
- };
- addSelectedRepoToRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["response"];
- };
approveWorkflowRun: {
parameters: RequestParameters &
Omit<
@@ -58,14 +42,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel"]["response"];
};
- createEnvironmentVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /repositories/{repository_id}/environments/{environment_name}/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /repositories/{repository_id}/environments/{environment_name}/variables"]["response"];
- };
createOrUpdateEnvironmentSecret: {
parameters: RequestParameters &
Omit<
@@ -90,14 +66,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"];
};
- createOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /orgs/{org}/actions/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /orgs/{org}/actions/variables"]["response"];
- };
createRegistrationTokenForOrg: {
parameters: RequestParameters &
Omit<
@@ -130,22 +98,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /repos/{owner}/{repo}/actions/runners/remove-token"]["response"];
};
- createRepoVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /repos/{owner}/{repo}/actions/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /repos/{owner}/{repo}/actions/variables"]["response"];
- };
- createRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /orgs/{org}/actions/required_workflows"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /orgs/{org}/actions/required_workflows"]["response"];
- };
createWorkflowDispatch: {
parameters: RequestParameters &
Omit<
@@ -186,14 +138,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"];
};
- deleteEnvironmentVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"];
- };
deleteOrgSecret: {
parameters: RequestParameters &
Omit<
@@ -202,14 +146,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}"]["response"];
};
- deleteOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /orgs/{org}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /orgs/{org}/actions/variables/{name}"]["response"];
- };
deleteRepoSecret: {
parameters: RequestParameters &
Omit<
@@ -218,22 +154,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"];
};
- deleteRepoVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /repos/{owner}/{repo}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /repos/{owner}/{repo}/actions/variables/{name}"]["response"];
- };
- deleteRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"];
- };
deleteSelfHostedRunnerFromOrg: {
parameters: RequestParameters &
Omit<
@@ -354,6 +274,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/actions/cache/usage-by-repository"]["response"];
};
+ getActionsCacheUsageForEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/actions/cache/usage"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/actions/cache/usage"]["response"];
+ };
getActionsCacheUsageForOrg: {
parameters: RequestParameters &
Omit<
@@ -402,13 +330,13 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}"]["response"];
};
- getEnvironmentVariable: {
+ getGithubActionsDefaultWorkflowPermissionsEnterprise: {
parameters: RequestParameters &
Omit<
- Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"],
+ Endpoints["GET /enterprises/{enterprise}/actions/permissions/workflow"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"];
+ response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/workflow"]["response"];
};
getGithubActionsDefaultWorkflowPermissionsOrganization: {
parameters: RequestParameters &
@@ -466,14 +394,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}"]["response"];
};
- getOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/variables/{name}"]["response"];
- };
getPendingDeploymentsForRun: {
parameters: RequestParameters &
Omit<
@@ -498,22 +418,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/public-key"]["response"];
};
- getRepoRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}"]["response"];
- };
- getRepoRequiredWorkflowUsage: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/timing"]["response"];
- };
getRepoSecret: {
parameters: RequestParameters &
Omit<
@@ -522,22 +426,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"]["response"];
};
- getRepoVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{owner}/{repo}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{owner}/{repo}/actions/variables/{name}"]["response"];
- };
- getRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"];
- };
getReviewsForRun: {
parameters: RequestParameters &
Omit<
@@ -626,14 +514,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/secrets"]["response"];
};
- listEnvironmentVariables: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repositories/{repository_id}/environments/{environment_name}/variables"]["response"];
- };
listJobsForWorkflowRun: {
parameters: RequestParameters &
Omit<
@@ -674,22 +554,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/actions/secrets"]["response"];
};
- listOrgVariables: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/variables"]["response"];
- };
- listRepoRequiredWorkflows: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{org}/{repo}/actions/required_workflows"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{org}/{repo}/actions/required_workflows"]["response"];
- };
listRepoSecrets: {
parameters: RequestParameters &
Omit<
@@ -698,14 +562,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/secrets"]["response"];
};
- listRepoVariables: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{owner}/{repo}/actions/variables"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{owner}/{repo}/actions/variables"]["response"];
- };
listRepoWorkflows: {
parameters: RequestParameters &
Omit<
@@ -714,22 +570,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/actions/workflows"]["response"];
};
- listRequiredWorkflowRuns: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{owner}/{repo}/actions/required_workflows/{required_workflow_id_for_repo}/runs"]["response"];
- };
- listRequiredWorkflows: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/required_workflows"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/required_workflows"]["response"];
- };
listRunnerApplicationsForOrg: {
parameters: RequestParameters &
Omit<
@@ -754,14 +594,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"];
};
- listSelectedReposForOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/variables/{name}/repositories"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/variables/{name}/repositories"]["response"];
- };
listSelectedRepositoriesEnabledGithubActionsOrganization: {
parameters: RequestParameters &
Omit<
@@ -770,14 +602,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/actions/permissions/repositories"]["response"];
};
- listSelectedRepositoriesRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["response"];
- };
listSelfHostedRunnersForOrg: {
parameters: RequestParameters &
Omit<
@@ -882,22 +706,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}"]["response"];
};
- removeSelectedRepoFromOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}"]["response"];
- };
- removeSelectedRepoFromRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["DELETE /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id}"]["response"];
- };
reviewPendingDeploymentsForRun: {
parameters: RequestParameters &
Omit<
@@ -938,6 +746,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels"]["response"];
};
+ setGithubActionsDefaultWorkflowPermissionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /enterprises/{enterprise}/actions/permissions/workflow"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/workflow"]["response"];
+ };
setGithubActionsDefaultWorkflowPermissionsOrganization: {
parameters: RequestParameters &
Omit<
@@ -978,22 +794,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /orgs/{org}/actions/secrets/{secret_name}/repositories"]["response"];
};
- setSelectedReposForOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PUT /orgs/{org}/actions/variables/{name}/repositories"]["response"];
- };
- setSelectedReposToRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"]["response"];
- };
setSelectedRepositoriesEnabledGithubActionsOrganization: {
parameters: RequestParameters &
Omit<
@@ -1010,38 +810,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /repos/{owner}/{repo}/actions/permissions/access"]["response"];
};
- updateEnvironmentVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}"]["response"];
- };
- updateOrgVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PATCH /orgs/{org}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PATCH /orgs/{org}/actions/variables/{name}"]["response"];
- };
- updateRepoVariable: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PATCH /repos/{owner}/{repo}/actions/variables/{name}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PATCH /repos/{owner}/{repo}/actions/variables/{name}"]["response"];
- };
- updateRequiredWorkflow: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PATCH /orgs/{org}/actions/required_workflows/{required_workflow_id}"]["response"];
- };
};
activity: {
checkRepoIsStarredByAuthenticatedUser: {
@@ -1616,6 +1384,22 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /users/{username}/settings/billing/actions"]["response"];
};
+ getGithubAdvancedSecurityBillingGhe: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/settings/billing/advanced-security"]["response"];
+ };
+ getGithubAdvancedSecurityBillingOrg: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /orgs/{org}/settings/billing/advanced-security"]["response"];
+ };
getGithubPackagesBillingOrg: {
parameters: RequestParameters &
Omit<
@@ -1796,6 +1580,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances"]["response"];
};
+ listAlertsForEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/code-scanning/alerts"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/code-scanning/alerts"]["response"];
+ };
listAlertsForOrg: {
parameters: RequestParameters &
Omit<
@@ -1883,10 +1675,10 @@ export type RestEndpointMethodTypes = {
addSelectedRepoToOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"],
+ Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"];
+ response: Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"];
};
codespaceMachinesForAuthenticatedUser: {
parameters: RequestParameters &
@@ -1907,10 +1699,10 @@ export type RestEndpointMethodTypes = {
createOrUpdateOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}"]["parameters"],
+ Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}"]["response"];
+ response: Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}"]["response"];
};
createOrUpdateRepoSecret: {
parameters: RequestParameters &
@@ -1963,10 +1755,10 @@ export type RestEndpointMethodTypes = {
deleteOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["DELETE /orgs/{org}/codespaces/secrets/{secret_name}"]["parameters"],
+ Endpoints["DELETE /organizations/{org}/codespaces/secrets/{secret_name}"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["DELETE /orgs/{org}/codespaces/secrets/{secret_name}"]["response"];
+ response: Endpoints["DELETE /organizations/{org}/codespaces/secrets/{secret_name}"]["response"];
};
deleteRepoSecret: {
parameters: RequestParameters &
@@ -1992,14 +1784,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /user/codespaces/{codespace_name}/exports"]["response"];
};
- getCodespacesForUserInOrg: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/members/{username}/codespaces"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/members/{username}/codespaces"]["response"];
- };
getExportDetailsForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -2019,18 +1803,18 @@ export type RestEndpointMethodTypes = {
getOrgPublicKey: {
parameters: RequestParameters &
Omit<
- Endpoints["GET /orgs/{org}/codespaces/secrets/public-key"]["parameters"],
+ Endpoints["GET /organizations/{org}/codespaces/secrets/public-key"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["GET /orgs/{org}/codespaces/secrets/public-key"]["response"];
+ response: Endpoints["GET /organizations/{org}/codespaces/secrets/public-key"]["response"];
};
getOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}"]["parameters"],
+ Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}"]["response"];
+ response: Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}"]["response"];
};
getPublicKeyForAuthenticatedUser: {
parameters: RequestParameters &
@@ -2099,10 +1883,10 @@ export type RestEndpointMethodTypes = {
listOrgSecrets: {
parameters: RequestParameters &
Omit<
- Endpoints["GET /orgs/{org}/codespaces/secrets"]["parameters"],
+ Endpoints["GET /organizations/{org}/codespaces/secrets"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["GET /orgs/{org}/codespaces/secrets"]["response"];
+ response: Endpoints["GET /organizations/{org}/codespaces/secrets"]["response"];
};
listRepoSecrets: {
parameters: RequestParameters &
@@ -2131,10 +1915,10 @@ export type RestEndpointMethodTypes = {
listSelectedReposForOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"],
+ Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["response"];
+ response: Endpoints["GET /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["response"];
};
preFlightWithRepoForAuthenticatedUser: {
parameters: RequestParameters &
@@ -2144,14 +1928,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/codespaces/new"]["response"];
};
- publishForAuthenticatedUser: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /user/codespaces/{codespace_name}/publish"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /user/codespaces/{codespace_name}/publish"]["response"];
- };
removeRepositoryForSecretForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -2163,10 +1939,10 @@ export type RestEndpointMethodTypes = {
removeSelectedRepoFromOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"],
+ Endpoints["DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"];
+ response: Endpoints["DELETE /organizations/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}"]["response"];
};
repoMachinesForAuthenticatedUser: {
parameters: RequestParameters &
@@ -2176,14 +1952,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/codespaces/machines"]["response"];
};
- setCodespacesBilling: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PUT /orgs/{org}/codespaces/billing"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PUT /orgs/{org}/codespaces/billing"]["response"];
- };
setRepositoriesForSecretForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -2195,10 +1963,10 @@ export type RestEndpointMethodTypes = {
setSelectedReposForOrgSecret: {
parameters: RequestParameters &
Omit<
- Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"],
+ Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["parameters"],
"baseUrl" | "headers" | "mediaType"
>;
- response: Endpoints["PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories"]["response"];
+ response: Endpoints["PUT /organizations/{org}/codespaces/secrets/{secret_name}/repositories"]["response"];
};
startForAuthenticatedUser: {
parameters: RequestParameters &
@@ -2314,22 +2082,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}"]["response"];
};
- listAlertsForEnterprise: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /enterprises/{enterprise}/dependabot/alerts"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /enterprises/{enterprise}/dependabot/alerts"]["response"];
- };
- listAlertsForOrg: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /orgs/{org}/dependabot/alerts"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /orgs/{org}/dependabot/alerts"]["response"];
- };
listAlertsForRepo: {
parameters: RequestParameters &
Omit<
@@ -2424,6 +2176,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"];
};
+ disableSelectedOrganizationGithubActionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"];
+ };
enableSelectedOrganizationGithubActionsEnterprise: {
parameters: RequestParameters &
Omit<
@@ -2432,6 +2192,30 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}"]["response"];
};
+ getAllowedActionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"];
+ };
+ getGithubActionsPermissionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/actions/permissions"]["response"];
+ };
+ getServerStatistics: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprise-installation/{enterprise_or_org}/server-statistics"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprise-installation/{enterprise_or_org}/server-statistics"]["response"];
+ };
listLabelsForSelfHostedRunnerForEnterprise: {
parameters: RequestParameters &
Omit<
@@ -2440,6 +2224,62 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"];
};
+ listSelectedOrganizationsEnabledGithubActionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /enterprises/{enterprise}/actions/permissions/organizations"]["response"];
+ };
+ removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"];
+ };
+ removeCustomLabelFromSelfHostedRunnerForEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}"]["response"];
+ };
+ setAllowedActionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/selected-actions"]["response"];
+ };
+ setCustomLabelsForSelfHostedRunnerForEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /enterprises/{enterprise}/actions/runners/{runner_id}/labels"]["response"];
+ };
+ setGithubActionsPermissionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions"]["response"];
+ };
+ setSelectedOrganizationsEnabledGithubActionsEnterprise: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PUT /enterprises/{enterprise}/actions/permissions/organizations"]["response"];
+ };
};
gists: {
checkIsStarred: {
@@ -2850,14 +2690,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/assignees/{assignee}"]["response"];
};
- checkUserCanBeAssignedToIssue: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}"]["response"];
- };
create: {
parameters: RequestParameters &
Omit<
@@ -3200,14 +3032,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /meta"]["response"];
};
- getAllVersions: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /versions"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /versions"]["response"];
- };
getOctocat: {
parameters: RequestParameters &
Omit<
@@ -3476,6 +3300,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PUT /orgs/{org}/outside_collaborators/{username}"]["response"];
};
+ createCustomRole: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["POST /orgs/{org}/custom_roles"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["POST /orgs/{org}/custom_roles"]["response"];
+ };
createInvitation: {
parameters: RequestParameters &
Omit<
@@ -3492,6 +3324,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["POST /orgs/{org}/hooks"]["response"];
};
+ deleteCustomRole: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["DELETE /orgs/{org}/custom_roles/{role_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["DELETE /orgs/{org}/custom_roles/{role_id}"]["response"];
+ };
deleteWebhook: {
parameters: RequestParameters &
Omit<
@@ -3580,6 +3420,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/blocks"]["response"];
};
+ listCustomRoles: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /organizations/{organization_id}/custom_roles"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /organizations/{organization_id}/custom_roles"]["response"];
+ };
listFailedInvitations: {
parameters: RequestParameters &
Omit<
@@ -3588,6 +3436,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /orgs/{org}/failed_invitations"]["response"];
};
+ listFineGrainedPermissions: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["GET /orgs/{org}/fine_grained_permissions"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["GET /orgs/{org}/fine_grained_permissions"]["response"];
+ };
listForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -3764,6 +3620,14 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["PATCH /orgs/{org}"]["response"];
};
+ updateCustomRole: {
+ parameters: RequestParameters &
+ Omit<
+ Endpoints["PATCH /orgs/{org}/custom_roles/{role_id}"]["parameters"],
+ "baseUrl" | "headers" | "mediaType"
+ >;
+ response: Endpoints["PATCH /orgs/{org}/custom_roles/{role_id}"]["response"];
+ };
updateMembershipForAuthenticatedUser: {
parameters: RequestParameters &
Omit<
@@ -6068,14 +5932,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}"]["response"];
};
- getSecurityAnalysisSettingsForEnterprise: {
- parameters: RequestParameters &
- Omit<
- Endpoints["GET /enterprises/{enterprise}/code_security_and_analysis"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["GET /enterprises/{enterprise}/code_security_and_analysis"]["response"];
- };
listAlertsForEnterprise: {
parameters: RequestParameters &
Omit<
@@ -6108,22 +5964,6 @@ export type RestEndpointMethodTypes = {
>;
response: Endpoints["GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations"]["response"];
};
- patchSecurityAnalysisSettingsForEnterprise: {
- parameters: RequestParameters &
- Omit<
- Endpoints["PATCH /enterprises/{enterprise}/code_security_and_analysis"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["PATCH /enterprises/{enterprise}/code_security_and_analysis"]["response"];
- };
- postSecurityProductEnablementForEnterprise: {
- parameters: RequestParameters &
- Omit<
- Endpoints["POST /enterprises/{enterprise}/{security_product}/{enablement}"]["parameters"],
- "baseUrl" | "headers" | "mediaType"
- >;
- response: Endpoints["POST /enterprises/{enterprise}/{security_product}/{enablement}"]["response"];
- };
updateAlert: {
parameters: RequestParameters &
Omit<
|